ProficientNowTechRFCs

5. Formatting Standards

RFC Authoring Standards                                           Section 5
Category: Standards Track                           Formatting Standards

5. Formatting Standards

← Content | Index | Next →


5.1 Document Header

Each file MUST begin with a header block:

 

RFC- Section N Category:


# N. Section Title

[← Previous: Title](./file.md) | [Index](./00-index.md) | [Next: Title →](./file.md)

---

5.2 Section Numbering

LevelFormatExample
Top-levelSingle integers1, 2, 3
SubsectionsDecimal notation1.1, 1.2, 2.1
Sub-subsectionsThree levels max1.1.1

Maximum depth SHOULD be three levels (1.1.1).


Each file MUST end with a navigation footer:

---
 
## Document Navigation
 
| Previous | Index | Next |
|----------|-------|------|
| [← N-1. Title](./file.md) | [Table of Contents](./00-index.md) | [N+1. Title →](./file.md) |
 
---
 
*End of Section N*

5.4 Tables

Tables SHOULD be used for:

Use CaseExample
Requirement matricesSection requirement levels
Component comparisonsFeature comparison
Status mappingsStatus definitions
Reference indexesRFC cross-references

Tables MUST have:

  • Headers
  • Consistent column alignment
  • Concise content (not prose)

5.5 Diagrams

Diagrams MUST use Mermaid syntax for:

Diagram TypeUse For
flowchartArchitecture overviews, trust boundaries
sequenceDiagramSequence flows, interactions
stateDiagram-v2State machines

All diagrams MUST be indexed in Appendix A (Glossary).


5.6 Code Blocks

Permitted

UseLanguage Hint
Mermaid diagramsmermaid
File paths and identifiersnone
Configuration keys (without values)none
Format specificationsmarkdown

Prohibited

ContentWhy
Implementation codeRFCs describe behavior
Working configurationBelongs in repos
Shell commandsRFCs are not runbooks
ScriptsImplementation detail

End of Section 5 — RFC Authoring Standards

On this page