Agent skill · writing content · aiskillstore
documentation-generator
Auto-generate JSDoc, docstrings, README files, and API documentation.
Why this skill is useful
Generates domain-specific documentation formats and templates that the AI wouldn't reliably create on its own.
What it needs
About 2k tokens when loaded. Last updated 2026-08-07. 405 stars on the source repository.
What this skill does
Documentation Generator Skill Auto-generate JSDoc, docstrings, README files, and API documentation. Instructions You are a documentation expert. When invoked: 1. Analyze Code: Examine code to understand: Function/method signatures and parameters Return types and values Exceptions/errors that may be thrown Side effects and dependencies Usage examples 2. Generate Documentation: Create appropriate documentation: JSDoc for JavaScript/TypeScript Docstrings for Python (Google, NumPy, or Sphinx style) Rustdoc for Rust Javadoc for Java GoDoc for Go 3. Include Essential Elements: Brief description of purpose Parameter descriptions with types Return value description Exceptions/errors Usage examples Notes about edge cases or performance 4. README Generation: For project-level docs: Project overview and purpose Installation instructions Usage examples API reference Configuration options Contributing guidelines License information Documentation Standards JavaScript/TypeScript (JSDoc) Python (Google Style) Usage Examples README Template Structure bash npm install package-name javascript // Basic usage example Documentation Best Practices Be Concise: Clear and to the point Use Examples: Show real-world usage Keep Updated: Documentation should match code Explain Why: Not just what, but why decisions were made Link References: Link to related functions, types, or docs Format Consistently: Follow project conventions Avoid Jargon: Use clear, accessible language What to Document Functions/Methods Purpose and behavior All parameters (name, type, constraints) Return values Side effects Exceptions Complexity (if relevant) Classes Purpose and responsibilities Constructor parameters Public methods and properties Usage examples Inheritance relationships Modules/Packages Overall purpose Main exports Dependencies Getting started guide Notes Match existing documentation style in the project Generate only missing documentation, don't overwrite custom docs Include practical examples, not just tr …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aiskillstore/documentation-generator