blob: d7ad4bf7a8ad7446bdd74b62c38503bee961e0c2 (
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
26
27
28
29
30
31
32
|
---
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.
## Subagents
When you need to delegate sub‑tasks, use the `pi-subagents` skill.
**Example:** For a new feature, assign a **scout** to extract API signatures from the `service` module, another **scout** to gather usage examples from the `cli` package, and an **implementer** to generate the corresponding README and API docs sections simultaneously.
*You may adapt the delegation pattern to fit the exact requirements of the codebase.*
## 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
|
