Technical Documentation Approach

Use Cases

Each use case will be described using a separate RST page (taken from URD) doc/sources/use_cases/use_case_.rst. Use case descriptions shall link to relevant processor / operation specification pages.

Processor / Operation Definitions

Each processor / operation will be specified using a separate RST pages in doc/sources/op_specs/op_spec_.rst. Processor / operation pages may link into use case descriptions.

TRD / TDD

Each Python module will have an introducing module-level doc-string with the following sections:::

"""
Module Description
==================
bla

Module Requirements
===================
Here: list of technical requirements (see below)

Module Reference
===================
"""

Module Description

Description of the module's purpose, contents, and usage. Module descriptions shall link to relevant processor / operation specification pages.

Module Requirements

Mapping from URD requirements to technical requirements to the unit-test that verify that the requirement is addressed and correctly implemented.

Module Reference

Nothing below here, because what follows will be the autodoc from Sphinx.