docs: descope components from MVP v1.0 scope#110
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the OpenSOVD MVP documentation to reflect a reduced v1.0 scope by explicitly marking multiple components as “descoped for v1.0” and updating the scope diagram/legend accordingly.
Changes:
- Updates
mvp.mdto separate supported vs. descoped v1.0 use-cases/requirements, and adds a dedicated “Descope” section clarifying what remains in v1.0. - Revises the high-level scope diagram to visually distinguish descoped components (grey) and adds a matching legend entry.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/design/mvp.md | Rewords v1.0 scope narrative, splits in-scope vs descoped items, and adds a “Descope” section plus updated diagram legend text. |
| docs/design/_assets/OpenSOVD-design-highlevel-scope-v1.drawio.svg | Updates the scope diagram styling/legend to show descoped components in grey. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
lh-sag
force-pushed
the
docs/mvp-scope-diagram
branch
from
948edb2 to
91c48b7
Compare
lh-sag
force-pushed
the
docs/mvp-scope-diagram
branch
from
91c48b7 to
6427fa5
Compare
There was a problem hiding this comment.
It is mentioned in the SOVD Client as offboard, onboard and cloud.
- so far, we are mostly doing the proximity diagnostics. Should we keep the cloud part?
- The SOVD clients are fragmented across the worksteams. we might have to consolidate what will be used for v1.0?
- The onboard client, im not sure, if there is something available ?
There was a problem hiding this comment.
It is mentioned in the SOVD Client as offboard, onboard and cloud.
- so far, we are mostly doing the proximity diagnostics. Should we keep the cloud part?
I agree the diagram is a bit misleading. I will change it to "offboard client". OK?
- The SOVD clients are fragmented across the worksteams. we might have to consolidate what will be used for v1.0?
- The onboard client, im not sure, if there is something available ?
Afair we chose curl as our offboard client.
There was a problem hiding this comment.
yes, off board client is ok.
|
|
||
| 1. Read DTCs through the SOVD API. | ||
| 1. Reach classic UDS ECUs via SOVD: the OpenSOVD Gateway exposes them through the Classic Diagnostic Adapter. | ||
| 1. Retrieve ECU-level metadata (e.g. HW revision, SW version) via SOVD. |
There was a problem hiding this comment.
Here I meant the SOVD protocol e.g. curl request.
| ## Use-cases | ||
|
|
||
| Following use-cases shall be supported by the MVP. | ||
| The following use-cases are supported by the reduced v1.0 scope. |
There was a problem hiding this comment.
Should we also include SOVD Server info with basic version-info ?
There was a problem hiding this comment.
During the workshop we discussed this and the sovd server does not add any additional value --> removing it does not add or remove any features. Hence we decided to remove it.
There was a problem hiding this comment.
ok understood,. i wasnt aware of it.
|
|
||
| 1. Read DTCs through the SOVD API. | ||
| 1. Reach classic UDS ECUs via SOVD: the OpenSOVD Gateway exposes them through the Classic Diagnostic Adapter. | ||
| 1. Retrieve ECU-level metadata (e.g. HW revision, SW version) via SOVD. |
There was a problem hiding this comment.
we could also include faults?
There was a problem hiding this comment.
As long as we have no commitment or clear owner I would argue against it.
If this changes we can add it back to v1.
Mark the diagnostic library, fault library, fault manager, SOVD server, service app, UDS2SOVD proxy and diagnostic DB as descoped for v1.0 and reconcile the MVP document with the reduced scope. - regenerate OpenSOVD-design-highlevel-scope-v1.drawio.svg from a clean, consistent draw.io source: descoped components use a grey "descoped for v1.0" gradient (vs the blue "partially in scope" gradient), with a new legend entry; SOVD Gateway, SOVD Client and Classic Diagnostic Adapter stay in v1.0 scope - mvp.md: explain the grey/dashed legend categories; add a Descope section listing the deferred components and the reduced v1.0 scope - mvp.md: split use-cases and requirements into v1.0 vs deferred, and frame the timeline as the post-v1.0 phasing roadmap
lh-sag
force-pushed
the
docs/mvp-scope-diagram
branch
from
6427fa5 to
07d67bb
Compare
Summary
This change marks the diagnostic library, fault library, fault manager, SOVD server, service app, UDS2SOVD proxy, and diagnostic DB as descoped for v1.0. The scope diagram now shows these components with a grey "descoped for v1.0" gradient and a matching legend entry, and the MVP document is updated to describe the reduced v1.0 scope.
Checklist