code-generate-document
Installation
SKILL.md
Generate missing documentation or architectural decision records (ADRs).
Process
-
Identify context:
- If code changes are involved: run
jj diff -sfirst to see changed files - If the user specified specific files or paths, focus on those
- If code changes are involved: run
-
Determine Documentation Type:
- Inline Docs: Docstrings, comments for functions/classes
- File/Module Docs: Top-level explanations (README.md updates)
- ADR: Architecture Decision Record for design choices
-
Execute based on type:
Inline/Module Docs:
- Read and understand the code
- Check existing doc style (Google, NumPy, Javadoc, etc.)
- Generate documentation that matches the project style
- Action: Propose changes to files