Technical Documentation
Installation
SKILL.md
Technical Documentation
Patterns for README, design documents, API specifications, and user guides.
Document Types
| Type | Audience | When to Use |
|---|---|---|
| README | Developers, contributors | Main project entry point |
| API Spec | API integrators | REST/GraphQL endpoints |
| Design Doc | Team, reviewers | Major features, architecture |
| User Guide | End users, admins | Help, tutorials, product guides |
Core Concepts
- Progressive disclosure: Quick start -> common cases -> advanced -> edge cases
- Audience-first: Match depth to reader's knowledge level
- Example-driven: Show working code, not just descriptions