Skip to content

Commit 706b83f

Browse files
committed
docs(roadmap): refine PI1 work breakdown for Release Gate v0.8
- Clarify automation checks are part of docs-as-code toolchain (//:docs) - Add CI/CD workflow item for requirement/architecture validation - Add inspection checklist completion item with team and process area - Add Module Verification Report completion item (pa5_verification) - Add outstanding implementation tickets item (pa4_impl) - Replace 'component' attribute references with 'team' - Remove Feasibility Check section
1 parent dcdf12d commit 706b83f

1 file changed

Lines changed: 47 additions & 38 deletions

File tree

docs/s_core_v_1/roadmap/pi1.rst

Lines changed: 47 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ Focus: Requirements Engineering (PA2) + Architecture Design (PA3)
2323
- Complete feature and component requirements for all modules (no open TBDs, status ``valid``)
2424
- Fill in and approve ``chklst_req_inspection.rst`` for all modules and features — each checklist point
2525
is either completed or the finding is noted in the checklist with a tracked issue;
26-
each tracked issue must have the **component** set and the **milestone** set
26+
each tracked issue must have the **team** set and the **milestone** set
2727
- Complete feature and component architecture for all modules (no open TBDs, status ``valid``)
2828
- Fill in and approve ``chklst_arc_inspection.rst`` for all modules and features — each checklist point
2929
is either completed or the finding is noted in the checklist with a tracked issue;
30-
each tracked issue must have the **component** set and the **milestone** set
30+
each tracked issue must have the **team** set and the **milestone** set
3131
- All requirements relevant for v1.0 must be explicitly marked as such
3232
- Implementation of functionality must be planned via tickets in the
3333
`main S-CORE GitHub project <https://github.com/orgs/eclipse-score/projects>`__ —
34-
each ticket must have the **component** set and the **milestone** set
34+
each ticket must have the **team** set and the **milestone** set
3535
- A Module Verification Report must be created for every module, tracking at minimum
3636
that unit-test coverage (C0/C1) reaches at least **90%** and dynamic code analysis
3737
(sanitizers: ASan/UBSan/LSan, TSan) passes with **0 findings**
@@ -45,38 +45,47 @@ See the relevant tables in :doc:`overall_status`:
4545
- :ref:`overall_status_pa3` — Architecture Design
4646
- :ref:`overall_status_pa5` — Verification / Coverage
4747

48-
Feasibility Check
49-
-----------------
50-
51-
Do we have everything in place to deliver the Release Gate v0.8 focus items?
52-
53-
**Tooling & Process**
54-
55-
- [ ] The S-CORE process templates (requirement, architecture, inspection checklists) are finalised and available
56-
- [ ] sphinx-needs / docs-as-code toolchain supports the required requirement types and attributes
57-
- [ ] CI pipeline enforces ``valid`` status and broken-link checks on requirements and architecture documents
58-
59-
**Inputs & Dependencies**
60-
61-
- [ ] Stakeholder requirements are stable enough to derive component requirements (no major scope changes expected)
62-
- [ ] Inter-module interfaces are sufficiently defined to allow architecture sign-off
63-
- [ ] External dependencies (e.g. AUTOSAR, SOME/IP specs) needed for requirements are accessible
64-
65-
**Definition of Done clarity**
66-
67-
- [ ] Acceptance criteria for "requirements complete" and "architecture complete" are agreed upon by all module owners
68-
- [ ] It is clear what "no open TBDs" means — a shared definition exists
69-
70-
**Verification — how do we ensure it was done?**
71-
72-
- [ ] Every module's ``chklst_req_inspection.rst`` and ``chklst_arc_inspection.rst`` are reviewed and merged into the module repo
73-
- [ ] The overall status tracker (``overall_status.rst``) reflects the current state for each module
74-
- [ ] All tracked findings from inspections have a linked GitHub issue with component + milestone set
75-
- [ ] A final Release Gate v0.8 review meeting confirms sign-off by module owners and process responsible
76-
77-
**Integration in Reference Integration**
78-
79-
- [ ] All modules with completed requirements and architecture are integrated in this reference integration repository
80-
- [ ] The reference integration build passes (no broken imports, no unresolved need IDs)
81-
- [ ] The documentation (this site) builds without warnings for all Release Gate v0.8 modules
82-
- [ ] The Release Gate v0.8 status table in ``overall_status.rst`` is updated to reflect the final state
48+
Work Breakdown
49+
--------------
50+
51+
- Mark every **feature requirement** that is in scope for v1.0 with the
52+
`valid_from <https://github.com/eclipse-score/docs-as-code/blob/main/src/extensions/score_metamodel/metamodel.yaml>`__
53+
attribute, set to one of the predefined release versions: ``v0.5``,
54+
``v0.7``, ``v0.8``, ``v0.9``, ``v0.10`` or ``v1.0`` (semantics: see
55+
`tool_req__docs_req_attr_validity_correctness
56+
<https://github.com/eclipse-score/docs-as-code/blob/main/docs/internals/requirements/requirements.rst>`__).
57+
Only feature requirements with ``valid_from`` set are considered relevant
58+
for v1.0; together with **all elements linked to them** — component
59+
requirements, AoUs, feature architecture and component architecture — they
60+
form the v1.0 scope and are the only elements counted in the roadmap
61+
statistics.
62+
- All in-scope feature requirements and the elements linked to them
63+
(component requirements, AoUs, feature architecture, component architecture)
64+
are in status ``valid``.
65+
- Implement all missing automation checks for requirement and architecture
66+
elements as part of the docs-as-code toolchain used for generation of the
67+
documentation (``//:docs``), as depicted in the *Process Status* pies on
68+
:doc:`overall_status` (PA2 / PA3 *Req. verification status*)
69+
- Provide a standardized CI/CD workflow for all implementation modules to
70+
validate requirements and architecture artifacts in compliance with the
71+
S-CORE process. The workflow shall be executed in the
72+
``reference_integration`` repository to verify, across all integrated
73+
modules, that the artifacts conform to the defined process and that the
74+
resulting documentation can be successfully generated.
75+
- Create and fully complete the inspection checklists for requirements and
76+
architecture. All findings shall be documented as tickets assigned to a
77+
milestone less than or equal to ``v1.0``, with the corresponding
78+
**team** attribute set and the **process area** set to ``pa2_req_eng``
79+
(for requirement findings) or ``pa3_arch_design`` (for architecture
80+
findings) respectively. Any alternative approach to the inspection
81+
checklists must first be agreed upon with the process community, and the
82+
decision must be documented.
83+
- All outstanding implementations of requirements relevant for ``v1.0``
84+
shall be tracked by tickets. Each ticket must be assigned to a milestone
85+
less than or equal to ``v1.0``, have the dedicated **team** attribute set,
86+
and have its **process area** set to ``pa4_impl``.
87+
- Create and fully complete the Module Verification Report for every
88+
module. All findings shall be documented as tickets assigned to a
89+
milestone less than or equal to ``v1.0``, with the corresponding
90+
**team** attribute set and the **process area** set to
91+
``pa5_verification``.

0 commit comments

Comments
 (0)