4.8 Documentation Directories

Go To Top

Return to Repository Layout

The docs/ directory should contain project documentation that belongs with the Repository. This may include developer notes, Repository instructions, generated documentation references, design notes, script usage, Node catalogue material, topic catalogue material, and acceptance documentation.

A representative structure is:

docs/
    handbook/
    developer-notes/
    nodes/
    topics/
    scripts/
    acceptance/

The team should use Repository documentation to explain implementation-specific details. The architecture documents remain authoritative for conceptual, logical, and Domain meaning. Repository documentation should help developers understand how the Phase 0 implementation expresses those architectural decisions.

Documentation should stay close to the Artifacts it explains when practical. For example, script documentation should match actual script behaviour, Node documentation should match actual Node responsibilities, and topic documentation should match the IDL and DDS topic definitions used by the implementation.