Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions How-to: S-Core process step-by-step.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# How-to: S-Core process step-by-step

## 1. Feature & Feature requirements in main score repository

### a. What to do

1. Define Feature
2. Define Feature Requirements and map them to the stakeholder requirements

### b. How to check

1. Automated checks for requirements in docs-as-code.
2. Checklist for things, that can not be automated -> automated check, that checklist is up to date.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,29 @@ pre-commit install --hook-type pre-push
```

Execute the pre-commit manually via `pre-commit run` or `pre-commit run --all-files` to run it on all files.

## Sphinx-needs processing rules

> [!WARNING]
> These rules are currently a **work-in-progress / demonstration** and are not yet production ready.

In addition to building the documentation, docs-as-code ships a set of Bazel macros
(in [docs.bzl](docs.bzl), backed by the Python tools in [scripts_bazel/](scripts_bazel))
that post-process the `needs.json` produced by the documentation build. They let you:

- **Filter** `needs.json` down to selected element types and/or components
(`filtered_needs_json`, plus convenience wrappers such as `component_requirements`,
`feature_requirements`, `assumptions_of_use`, `feature_architecture`, `component_architecture`).
- **Render** the selected needs as a Markdown document (`sphinx_needs_to_md`).
- **Convert** S-CORE requirements into [TRLC](https://github.com/bmw-software-engineering/trlc)
(`sphinx_needs_to_trlc`).
- **Validate checklists** by pinning a SHA256 hash on a `mod_insp` / `mod_ver_report`
record and failing the build when the reviewed output drifts
(`requirements_checklist`, `architecture_checklist`, `dfa_checklist`,
`fmea_checklist`, `verification_report`).
- **Bundle** a component's or feature's checklists, docs and sub-components
(`score_component`, `score_module`).

See [scripts_bazel/README_needs_rules.md](scripts_bazel/README_needs_rules.md) for the
full guide, including usage examples, transitive-dependency hashing and resolving
external needs via `extra_needs`.
Loading
Loading