Usage¶
This documentation supports two types of data contributions:
Open and freely accessible content: Related to Open-Source projects and publicly available tools.
Closed and internal content: Related to in-house tools and workflows.
The examples and explanations in this documentation focus on the first use case. Specific requirements for secured, internal data contributions are described later.
Add Data¶
Use Cases¶
Use cases are the starting point for the specification and requirements. They describe the tasks to be performed and the expected results. Use cases are linked to specific tool features that help achieve the desired outcome.
Use cases are stored in the /use_cases folder.
Example
.. usecase:: Document SW architecture <- Title
:id: UC_SW_ARCH <- Unique ID
:inputs: <- Needed input artifacts
:outputs: <- Result artifacts
:tools: TOOL_SPHINX, TOOL_SN <- List of used tools
:features: FE_SPINX_ARCH <- List of used features
:ti: 2 <- Tool impact level
Create documentation to document and track software architecture.
The documentation is used as part of an official release delivery.
Features & Errors¶
Features are stored in tool-specific folders, such as /tools/Dahlke.PressCenter/.
Example
.. feature:: Read Traceability objects <- Feature title
:id: FE_SN_READ <- Unique ID
:tools: TOOL_SN <- Tool link
:td: <- Combined Tool Error Detection level
Read Traceability objects from rst/md files
into the internal storage.
.. error:: Syntax errors in rst/md files <- A first error with title
:id: ER_SN_SYN_ER <- Unique ID
:td: 1 <- Tool Error Detection level
.. error:: Missing external needs.json file <- A second error with title
:id: ER_SN_JSON_NOT_FOUND <- Unique ID
:td: 3 <- Tool Error Detection level