documentation-knowledge
Installation
SKILL.md
Documentation Knowledge Base
Quick reference for technical documentation types, audiences, and best practices.
Documentation Types
By Purpose
| Type | Audience | Goal | Examples |
|---|---|---|---|
| README | New users | Quick start | badges, install, basic usage |
| Architecture | Developers | System understanding | layers, components, decisions |
| API | Integrators | Integration | endpoints, params, responses |
| ADR | Team | Decision history | context, decision, consequences |
| Getting Started | Beginners | First success | step-by-step tutorial |
| Reference | All | Quick lookup | methods, options, configs |
| Troubleshooting | Users | Problem solving | FAQ, error messages, solutions |
| CHANGELOG | All | Version history | features, fixes, breaking |