[rules score] add user documentation#226
Merged
Merged
Conversation
hoe-jo
requested review from
LittleHuba,
castler,
limdor and
ramceb
as code owners
- add User Guide - Refactor Index - extend rule reference
hoe-jo
force-pushed
the
joho_add_user_documentation
branch
from
7454e60 to
c520271
Compare
hoe-jo
force-pushed
the
joho_add_user_documentation
branch
2 times, most recently
from
e463cd3 to
e4602af
Compare
castler
previously approved these changes
May 20, 2026
Contributor
castler
left a comment
castler
left a comment
There was a problem hiding this comment.
We are missing in this documentation still
- the manual analysis
- how to reference requirements in tests
- Documentation about how to enforce checklist in the GitHub Actions
| Overview | ||
| ======== | ||
|
|
||
| ``rules_score`` organises safety-critical software artefacts into four groups: |
Contributor
There was a problem hiding this comment.
We should write here a short section about the goals and how they are achieved.
|
|
||
| For the complete `dependable_element` attribute reference, see {ref}`dependable_element <rule-dependable-element>` in the rule index. | ||
|
|
||
| ## Automatic Validations |
Contributor
There was a problem hiding this comment.
- Correct linkage of requirements
- Impact check for requirements changes via versioning
- Requirements Checklist fulfillment via AI scoring
- Ensured traceability in CI overall required work products
- SW-Unit Design consistency with Code
- Need for Manual Analysis reexecution
|
|
||
| All requirements are written in [TRLC](https://github.com/bmw-software-engineering/trlc) (Traceability Requirements Language Checker). Each record maps to a specific `ScoreReq` type defined in the [S-CORE requirements model](https://github.com/eclipse-score/tooling/blob/main/bazel/rules/rules_score/trlc/config/score_requirements_model.rsl). | ||
|
|
||
| For `TRLC` both a VSCode Extension and a LSP Server (e.g. for Clion) are [available](https://github.com/bmw-software-engineering/trlc-vscode-extension) |
Contributor
There was a problem hiding this comment.
We should add a tutorial (at least for Clion) how to set this up.
|
|
||
| | Level | Design rule | Content | | ||
| |---|---|---| | ||
| | SEooC / component | `architectural_design` | Static structure, dynamic behaviour, public API | |
Contributor
There was a problem hiding this comment.
Please reference here in "content" the respective sections from the ISO26262
|
|
||
| ## `unit_design` — Code-Level Design Diagrams | ||
|
|
||
| The `unit_design` rule attaches PlantUML diagrams to a unit. It uses the same `static` / `dynamic` category split as `architectural_design`, but scoped to a single unit's implementation. |
Contributor
There was a problem hiding this comment.
We should details this here more. What do we expect to see, what diagram types are supported. An example. How does this relate to the code.
hoe-jo
force-pushed
the
joho_add_user_documentation
branch
from
e4602af to
691e5f2
Compare
github-project-automation
Bot
moved this from Backlog
to Done
in INF - Infrastructure Community
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.