Use cases

Requirements

Use Case: Document software requirements UC_SW_REQ

status: done style: purple_bar ti: 2 tcl: tbd priority: 1 features: FE_SPHINX_READ, FE_SN_READ, FE_SN_CONTENT_RENDER, FE_SN_SET_META, FE_SN_LINK tools: TOOL_SPHINX, TOOL_SN, TOOL_UBC

Create documentation to document and track software requirements. Input are rst files and output is a static website with HTML, CSS and JS files. The documentation is used as part of an official release delivery.

Architectures

Use Case: Document SW architecture UC_SW_ARCH

style: purple_bar ti: 2 tcl: tbd tools: TOOL_SPHINX, TOOL_SN

Create documentation to document and track software architecture. The documentation is used as part of an official release delivery.

SW APIs

Use Case: Document SW Detail Design (SW API) UC_SW_API

style: purple_bar ti: 2 tcl: tbd tools: TOOL_SPHINX, TOOL_SN

Create documentation to document and track software detailed design. The documentation is used as part of an official release delivery.

Tests

Use Case: Document SW Unit test cases UC_UNIT_TEST

style: purple_bar ti: 2 tcl: tbd tools: TOOL_SPHINX, TOOL_SN

Create documentation to document and track software unit test cases. The documentation is used as part of an official release delivery.

Use Case: Document Test results of SW Unit tests UC_UNIT_TEST_RESULTS

style: purple_bar ti: 2 tcl: tbd tools: TOOL_SPHINX, TOOL_SN

Document the result of certain test runs and link them to the related test cases. Create also test result overview pages with tables and pie charts. The documentation is used as part of an official release.

Qualifications

Use Case: Document software qualification tests and results UC_SW_QA

style: purple_bar ti: 2 tools: TOOL_SPHINX, TOOL_SN

Create documentation to document software qualification. The documentation is used as part of an official release delivery.