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
ADR
Architecture Decision Records for documenting architectural choices.
RFC
Request for Comments for proposing and discussing changes.
Design Doc
Detailed technical designs for complex features.
Quick Comparison
| Aspect | ADR | RFC | Design Doc |
|---|---|---|---|
| Purpose | Record decisions | Propose changes | Detail designs |
| Length | Short (1-2 pages) | Medium (2-5 pages) | Long (5+ pages) |
| Scope | Single decision | Feature/change proposal | Complete feature design |
| Audience | Future developers | Team for review | Implementation team |
| Sign-offs | Optional | Recommended | Required |
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 ADRCommon Workflows
ADR Workflow
- Identify a decision to be made
- Create an ADR documenting options
- Choose an option and document reasoning
- (Optional) Request sign-offs
- Mark as Accepted
RFC Workflow
- Identify a change or improvement
- Create RFC with proposal details
- Share with team for feedback
- Iterate based on comments
- Request sign-offs
- Mark as Accepted or Closed
Design Doc Workflow
- Plan a significant feature
- Create Design Doc with full details
- Include diagrams and technical specs
- Request sign-offs from stakeholders
- Mark as Accepted
- Reference during implementation