document

Generate inline comments, API references, and user guides from codebases.

11|1|Updated Jan 21, 2026
One-click install
npx skills add https://github.com/agoodway/.claude --skill document-agoodway
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document
Source: https://github.com/agoodway/.claude/tree/main/skills/document
Command: npx skills add https://github.com/agoodway/.claude --skill document-agoodway

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation is often time-consuming and inconsistent across components, APIs, and features. This Skill automates the creation of focused, high-quality docs from code and interfaces, reducing manual effort and improving maintainability.

Core Features & Use Cases

  • Generate Inline Documentation: produce JSDoc-like inline comments and doc blocks from codebases.
  • API Reference & Guides: create API reference material, usage guides, and user-facing docs.
  • Multi-Format Output: support inline docs, external guides, and developer references for React, Phoenix, and backend services.

Quick Start

Use the document skill to generate docs for a component, example: /document src/auth/login.js with inline JSDoc comments

Frequently Asked Questions about document

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate API documentation from an existing codebase?▼

You can generate inline documentation by feeding your source files to this Skill, which analyzes code structure and outputs JSDoc-like inline comments and doc blocks automatically.

Can I use this to create API reference docs for a React project?▼

Yes, you can create API reference docs for React projects. It analyzes component interfaces and generates multi-format documentation tailored for both front-end and back-end stacks.

Does this documentation generator work with Phoenix backend services?▼

This documentation generator works with Phoenix backend services, extracting interfaces and outputting user-facing guides and developer references that integrate with existing documentation ecosystems.

What is the best way to maintain consistent formatting across multiple code component docs?▼

The best way to maintain consistent formatting across code component docs is to automate generation using this Skill, which applies standardized formatting rules when extracting interfaces and outputting references.

Do I need any external dependencies to analyze code structure and extract interfaces?▼

You do not need any external dependencies to analyze code structure and extract interfaces. This Skill operates independently to parse code and generate multi-format documentation outputs.