inline-documentation

Add JSDoc and docstrings to public functions and classes.

11|Updated Dec 2, 2025
One-click install
npx skills add https://github.com/troykelly/claude-skills --skill inline-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: inline-documentation
Source: https://github.com/troykelly/claude-skills/tree/main/skills/inline-documentation
Command: npx skills add https://github.com/troykelly/claude-skills --skill inline-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures code is thoroughly documented inline (JSDoc/docstrings) so automated documentation can be generated accurately.

Core Features & Use Cases

  • Thorough inline documentation for public APIs
  • Comprehensive docstrings and examples
  • Guidance on non-obvious decisions
  • Consistent documentation style aligned with project standards

Quick Start

Add detailed JSDoc/docstrings to public functions/classes, including parameter types, return types, and examples.