Overview

rules_score organises safety-critical software artefacts into four groups:

Documentation Rule — the generic Sphinx builder underlying all other rules:

• sphinx_module — Builds Sphinx HTML from RST/MD sources with dependency merging

Artifact Rules — declare individual process work products:

• assumed_system_requirements — System-level requirements received from the wider context

• feature_requirements — High-level feature specifications

• component_requirements — Component-level requirements

• assumptions_of_use — Safety-relevant operating conditions imposed on the integrator

• architectural_design — Software architecture (static, dynamic, public API)

• unit_design — Code-level design diagrams scoped to a single unit

• fmea — Failure Mode and Effects Analysis (failure modes, FTA, control measures)

• dependability_analysis — Complete safety analysis wrapping one or more FMEA targets

Structural Rules — wire artefacts into a verifiable SEooC:

• unit — Smallest testable software element (design + implementation + tests)

• component — Collection of units providing specific functionality

• dependable_element — Complete SEooC with all artefacts assembled and validated

All rules support cross-module dependencies for sphinx-needs integration and HTML merging.

Architecture diagram