blob: 6d6a6e10dba216be0e7856408a96a4e2fff8b65c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
|
---
name: documentation
description: "Generate/update README/API/architecture docs from the actual implementation rather than inventing behavior."
---
# Documentation Skill
Generate/update README/API/architecture docs from the actual implementation rather than inventing behavior.
## Principles
### Source of Truth
- Read code first
- Document what exists
- Don't speculate on behavior
### Types
- README: project overview, setup, usage
- API: public interfaces, parameters, returns
- Architecture: module boundaries, data flow
### Maintenance
- Update with code changes
- Delete stale documentation
- Link to code references
|
