apd-ds-document-project
| apd-ds-document-project | |
|---|---|
| Version | 1.0 |
| Category | Shared |
| Type | Documentation generator |
| Cost / run | TBD |
| Best models | TBD |
Shared › apd-ds-document-project
Generates function docstrings across a project plus a high-level overview markdown, turning an undocumented codebase into something a new team member (or the next agent session) can navigate.
Available as $apd-ds-document-project / /apd-ds-document-project (source · tests).
How to use
- In Claude Code / Codex, open the project to document
- Invoke the skill; scope it to specific folders if you only need part of the codebase covered
- Review the generated docstrings and overview in a diff before committing
Document this project: docstrings for everything in src/, plus a
high-level overview markdown explaining the pipeline stages.
Tips
| Do | Why |
|---|---|
| Run it on a clean branch | Docstring generation touches many files; keep the diff reviewable |
| Verify domain claims | It infers intent from code; check the overview's claims about why things exist |
| Pair with code review at handoff | Reviewed + documented is the standard for client handovers |
Related skills
| Skill | Relationship |
|---|---|
apd-ds-code-review |
Review counterpart; fix issues first, then document the final state |