Summary
This is a comprehensive reference for writing documentation that developers will actually read. It covers the full spectrum: README templates with quick start sections, JSDoc and OpenAPI specs for APIs, inline commenting guidelines that explain when to comment and when not to, plus architecture decision records. The inline comment examples are especially practical, showing the difference between explaining why you used binary search versus pointlessly commenting that you're incrementing a counter. It also includes that crucial principle that stale docs are worse than no docs. Use this when you're documenting a new API, writing a README for an open source project, or trying to figure out what level of detail your comments actually need.
Install to Claude Code
npx -y skills add moizibnyousaf/ai-agent-skills --skill code-documentation --agent claude-codeInstalls into .claude/skills of the current project.
Agent, run crypto. Access onchain data & trade routes via 1inch.
Install now →
On Capafy, your Skill runs online 24/7 as an agent product, and you get paid every time someone uses it.
Start earning →
An agent that runs the SEO playbooks that move rankings and ships PRs you control.
Get founding access →
Connect Claude to +800M contacts, +150M companies. Find & Enrich leads in chat.
Try For Free →Files
SKILL.md
Select a file.
Featured
Agent, run crypto. Access onchain data & trade routes via 1inch.
Install now →On Capafy, your Skill runs online 24/7 as an agent product, and you get paid every time someone uses it.
Start earning →An agent that runs the SEO playbooks that move rankings and ships PRs you control.
Get founding access →Connect Claude to +800M contacts, +150M companies. Find & Enrich leads in chat.
Try For Free →
