Written Documentation
Back: Technical Communication
The various types of documentation that engineering teams produce. Good documentation is a force multiplier that reduces onboarding time, prevents knowledge loss, and enables async collaboration.
Concepts
- README
- API Documentation
- Architecture Documentation
- Architecture Decision Records
- RFCs
- Runbooks
- Onboarding Docs
- Changelogs