1.4 How to Use This Handbook

Go To Top

Return to Purpose and Scope

This handbook should be used as the operational companion to the architecture documents. Parts 1 through 4 remain authoritative for conceptual framing, distributed logical architecture, the FX Demo Logical Profile, and Phase 0 implementation source material. This handbook provides the development conventions and execution practices needed to implement the Phase 0 Baseline consistently.

Developers should use the handbook before creating or modifying implementation Artifacts. Repository structure, file naming, generated Artifacts, script conventions, Node behaviour, logging, Exception Handling, and documentation expectations should be checked against this handbook before changes are committed.

Reviewers should use the handbook as a checklist for implementation discipline. A change should not be accepted simply because it works locally. It should also be Traceable, Reproducible, documented, reviewable, and consistent with the Phase 0 Baseline.

The handbook should also be treated as a living Baseline document. If the team makes a deliberate implementation decision that changes the expected Repository structure, tooling, scripts, generated Artifacts, Node pattern, or Acceptance Criteria, the handbook should be updated so that the written guidance and the actual implementation remain aligned.

The practical test for this handbook is whether a qualified team member can use it to check out the Repository, prepare the environment, generate required Artifacts, build the containers, run the Node network, observe Control Plane status, stop the system, inspect logs, and understand whether the Phase 0 Baseline has met its Acceptance Criteria.