ArchDoc Documentation

Document Types

Understanding ADRs, RFCs, and Design Docs in ArchDoc

Document Types Overview

ArchDoc supports three types of technical documents, each serving a specific purpose in your engineering workflow.

Document Types

Quick Comparison

AspectADRRFCDesign Doc
PurposeRecord decisionsPropose changesDetail designs
LengthShort (1-2 pages)Medium (2-5 pages)Long (5+ pages)
ScopeSingle decisionFeature/change proposalComplete feature design
AudienceFuture developersTeam for reviewImplementation team
Sign-offsOptionalRecommendedRequired

Document Categories

All documents in ArchDoc have one of three categories:

In Progress

  • Document is being drafted
  • Still accepting edits
  • Sign-offs pending

Accepted

  • Document has been approved
  • Sign-offs complete
  • Ready for implementation

Closed

  • Document is no longer active
  • Could be superseded or rejected
  • Preserved for historical reference

Choosing the Right Type

Use this decision tree:

Is this a single architectural choice?
├── Yes → ADR
└── No
    ├── Are you proposing a change for team discussion?
    │   ├── Yes → RFC
    │   └── No
    │       └── Is this a detailed technical design?
    │           ├── Yes → Design Doc
    │           └── No → Consider ADR

Common Workflows

ADR Workflow

  1. Identify a decision to be made
  2. Create an ADR documenting options
  3. Choose an option and document reasoning
  4. (Optional) Request sign-offs
  5. Mark as Accepted

RFC Workflow

  1. Identify a change or improvement
  2. Create RFC with proposal details
  3. Share with team for feedback
  4. Iterate based on comments
  5. Request sign-offs
  6. Mark as Accepted or Closed

Design Doc Workflow

  1. Plan a significant feature
  2. Create Design Doc with full details
  3. Include diagrams and technical specs
  4. Request sign-offs from stakeholders
  5. Mark as Accepted
  6. Reference during implementation

Getting Started

On this page