4. Formatting Standards
4. Formatting Standards
← Structure | Index | Next →
4.1 Document Header
Each file in an Architecture RFC MUST begin with:
RFC- Section N Category:
4.2 Diagram Requirements
Architecture RFCs SHOULD include diagrams for:
| Concept | Diagram Type | Required |
|---|---|---|
| System overview | flowchart | RECOMMENDED |
| Trust boundaries | flowchart | CONDITIONAL (if security-relevant) |
| Data flows | sequenceDiagram | RECOMMENDED |
| State transitions | stateDiagram-v2 | OPTIONAL |
| Component relationships | flowchart | RECOMMENDED |
All diagrams MUST use Mermaid syntax.
4.3 Invariant Format
Invariants MUST follow this format:
Example:
4.4 Trust Boundary Format
Trust boundaries SHOULD be illustrated using Mermaid flowcharts with subgraphs:
4.5 Component Format
Components SHOULD be documented using tables:
4.6 Rejected Alternative Format
Rejected alternatives MUST follow this format:
4.7 Navigation Links
Each file MUST include navigation links after the header:
The index file uses:
4.8 Section Separators
Use horizontal rules (---) to separate:
| Usage | Placement |
|---|---|
| After navigation links | Before content begins |
| Before section footer | After content ends |
| Between major subsections | When logical break needed |
End of Section 4 — RFC-RFCSTD-0002