4.8 Documentation Directories [Dido Solutions, Inc Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== 4.8 Documentation Directories ======

[[fxdemo:05-part:start | Go To Top ]]

[[fxdemo:05-part:04-repository-layout:start | Return to Repository Layout ]]

The ''docs/'' directory should contain project documentation that belongs with the [[dido:99_annexes:annex-b-terms-and-definitions:r:repository|Repository]]. This may include developer notes, Repository instructions, generated documentation references, design notes, script usage, [[dido:99_annexes:annex-b-terms-and-definitions:n:node|Node]] catalogue material, topic catalogue material, and acceptance documentation.

A representative structure is:

<code>
docs/
    handbook/
    developer-notes/
    nodes/
    topics/
    scripts/
    acceptance/
</code>

The team should use Repository documentation to explain implementation-specific details. The architecture documents remain authoritative for conceptual, logical, and [[dido:99_annexes:annex-b-terms-and-definitions:d:domain|Domain]] meaning. Repository documentation should help developers understand how the Phase 0 implementation expresses those architectural decisions.

Documentation should stay close to the [[dido:99_annexes:annex-b-terms-and-definitions:a:artifact|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 [[dido:99_annexes:annex-b-terms-and-definitions:i:idl|IDL]] and [[dido:99_annexes:annex-b-terms-and-definitions:d:dds|DDS]] topic definitions used by the implementation.

----

<WRAP centeralign>

© 2026 Dido Solutions, Inc. and Jackrabbit Consulting, Inc.

</WRAP>