Agent skill · writing content · aj-geddes
code-documentation
Write comprehensive code documentation including JSDoc, Python docstrings, inline comments, function documentation, and API comments. Use when documenting code, writing docstrings, or creating inline documentation.
Why this skill is useful
Codifies best practices for code documentation but AI already knows general documentation techniques.
What it needs
About 2k tokens when loaded. Last updated 2026-03-04. 307 stars on the source repository.
What this skill does
Code Documentation Table of Contents Overview When to Use Quick Start Reference Guides Best Practices Overview Create clear, comprehensive code documentation using language-specific standards like JSDoc, Python docstrings, JavaDoc, and inline comments. When to Use Function and class documentation JSDoc for JavaScript/TypeScript Python docstrings JavaDoc for Java Inline code comments API documentation from code Type definitions Usage examples in code Quick Start Minimal working example: Reference Guides Detailed implementations in the references/ directory: Guide Contents --- --- Function Documentation Function Documentation Class Documentation Class Documentation Type Definitions Type Definitions Function Documentation Function Documentation Class Documentation Class Documentation Module Documentation Module Documentation Best Practices ✅ DO Document public APIs thoroughly Include usage examples Document parameters and return values Specify thrown exceptions/errors Use language-specific standards (JSDoc, docstrings, etc.) Keep comments up-to-date Document "why" not "what" Include edge cases and gotchas Add links to related functions Document type definitions Use consistent formatting ❌ DON'T State the obvious in comments Leave commented-out code Write misleading comments Skip examples for complex functions Use vague parameter descriptions Forget to update docs when code changes Over-comment simple code
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aj-geddes/code-documentation