API Docs Writer Skill: Inline Docs From the Current Diff
Adds JSDoc, TSDoc, or docstrings to exports in your current change. Most docs go stale the moment they ship because nobody re-runs the doc step on a change.
Full Prompt
An installable docs-writer skill that adds inline reference docs to exported functions in the current change. Skips trivial getters and keeps signatures tight.
What It Does
- Works on the diff — documents what changed, not the whole repo
- Matches your dialect — TSDoc, JSDoc, Google/NumPy, godoc, rustdoc
- Skips noise — trivial getters, generated code, internal helpers
- Useful @example — runnable, short, only when the call shape isn't obvious
Install in 30 Seconds
Pick your tool above and download:
- Claude Code:
~/.claude/skills/api-docs-writer/SKILL.md - OpenAI Codex CLI: append to
AGENTS.md - Cursor: append to
.cursorrules
Same content, three install paths. Reload and ask for the audit on your next change.
Why This Skill Earns Its Keep
Most docs go stale the moment they ship because nobody re-runs the doc step on a change. This skill makes the doc pass a normal part of the PR loop: it reads the diff, adds what's missing, leaves trivial code alone, and refuses to invent contracts the code doesn't actually enforce.
Install once, run before every push.