8 Documentation Infrastructure ⚪¶
Infrastructure supporting engineering documentation across S-CORE repositories.
⚠️ This chapter is not yet reviewed by documentation experts.
S-CORE
- Documentation infrastructure in S-CORE currently spans repository documentation sites and engineering-focused docs-as-code capabilities.
- Documentation is published through CI-driven static site generation and hosting.
- Engineering traceability (requirements, architecture, design, implementation, tests) is a target capability for functional safety compliance.
8.1 Authoring & Tooling ⚪¶
Capabilities for writing, structuring, and maintaining documentation in repositories.
S-CORE
- Documentation is authored in version-controlled repositories alongside source code.
- Markdown and rST are the primary input formats.
8.1.1 IDE & Developer Experience¶
Providing fast feedback while authoring documentation locally.
8.2 Build, Validation & Publishing ⚪¶
Infrastructure for builds, quality checks, and publication of documentation sites.
8.2.1 Deterministic Build and Configuration¶
Ensuring reproducible documentation output across local and CI environments.
8.2.2 Validation, Previews, and Publishing¶
Providing contributor feedback before merge through fast preview and validation workflows.
8.3 Cross-Repository Documentation Integration ⚪¶
Connecting documentation across repositories with stable linking and navigation patterns.
8.3.1 Cross-Repository Linking¶
Establishing reliable links across repository boundaries and release versions.
8.3.2 Shared Navigation and Discovery¶
Making documentation content easier to discover across repository-specific sites.
8.4 Engineering Documentation & Traceability ⚪¶
Infrastructure supporting requirements, architecture, design, and links to implementation and tests.
S-CORE
- Engineering documentation (requirements, architecture, detailed design) is required for process compliance (e.g. ISO 26262, ASPICE).
- Architecture visualization and code integration are target capabilities to connect documentation with implementation artifacts.
8.4.1 Traceability, Code Integration, and Impact Analysis¶
Linking requirements, design, code, and verification artifacts to support impact analysis.