Introduction¶
Classification for Sphinx + X
Qualify your Sphinx-based documentation toolchain for safety audits required by ISO 26262, IEC 61508, EN 50716, and more.
This documentation provides the necessary information to achieve
“qualification readiness” for any Sphinx-based project. It includes use cases,
features, errors, and restrictions represented as Sphinx-Needs
objects.
The classification serves as the foundation for any qualification process. Additional qualification support is available through a commercial Qualification Kit provided by useblocks and Innotec.
Hint
Project Status
This documentation is in its early stages. Tools and data are currently being collected and classified. Contributions are welcome! Visit our GitHub repository at https://github.com/useblocks/sphinx-safety/ to join as a user or contributor.
The current status and problemeatic entries can seen in Analysis and Qualification Completeness.
Supported Standards¶
This documentation provides essential information for the classification of Sphinx and Sphinx-Needs according to the following standards:
Tool Scope¶
The classification and qualification documentation cover the following tools:
Title |
ID |
Version |
Status |
|---|---|---|---|
Sphinx-Needs |
5.1.0, 4.2.0 |
in_progress |
|
Sphinx |
7.4.7, 8.2.3 |
in_progress |
|
Sphinx-Test-Reports |
in_progress |
||
ubc |
in_progress |
||
ubCode |
in_progress |
||
ubTrace |
in_progress |
Please note that this classification does not cover all features of a tool. It focuses exclusively on safety-relevant use cases. As a result, a Tool Confidence Level (TCL) is assigned to individual use cases rather than the tool as a whole.
Use Case Scope¶
ID |
Title |
TI |
TCL |
|---|---|---|---|
Document SW Detail Design (SW API) |
2 |
tbd |
|
Document SW architecture |
2 |
tbd |
|
Document software qualification tests and results |
2 |
||
Document software requirements |
2 |
tbd |
|
Document SW Unit test cases |
2 |
tbd |
|
Document Test results of SW Unit tests |
2 |
tbd |
Support¶
Tool Support
useblocks GmbH is a German solution provider specializing in documentation tools for software development teams, with a strong focus on the “docs-as-code” methodology. Their expertise lies in integrating documentation seamlessly into development workflows, enabling teams to treat documentation as an integral part of their codebase. This approach ensures consistency, version control, and collaboration across teams.
Consultancy Support
innotec GmbH, a member of the TÜV Austria Group, is a German consultancy specializing in functional safety across various sectors, including automotive, machinery, and embedded systems. Their expertise encompasses comprehensive support for tool qualification and validation, ensuring compliance with standards such as ISO 26262, IEC 61508, and EN 50128.
