document

Generate inline docs, API references, and user guides from code analysis.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/nxy7/streampai-elixir --skill document-nxy7
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document
Source: https://github.com/nxy7/streampai-elixir/tree/main/.claude/skills/document
Command: npx skills add https://github.com/nxy7/streampai-elixir --skill document-nxy7

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation tends to be inconsistent, incomplete, and hard to maintain across codebases. This Skill automates focused documentation generation to keep components, APIs, and features well-described and up-to-date.

Core Features & Use Cases

  • Inline Documentation: Generate inline comments and docstrings for functions, components, and modules.
  • API References: Create comprehensive API reference material with endpoints, parameters, and examples.
  • User Guides & Tutorials: Produce user-friendly guides and tutorials that help developers adopt features quickly.
  • External Docs: Generate external documentation pages for integration and onboarding.

Quick Start

Use the document skill to generate API references for the React Button component in docs/

Frequently Asked Questions about document

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

FAQPage Schema
How do I generate inline documentation for my React components?

You can generate inline documentation for React components by running code analysis to extract interfaces and apply project-specific formatting. This produces consistent docstrings and comments ready for publication directly within your existing codebase.

What is the best way to create API references from an existing codebase?

The best way to create API references is by using code analysis to extract endpoints, parameters, and examples from your codebase. This approach delivers comprehensive and consistently formatted API reference material ready for publication.

Can I use this to generate developer docs for Phoenix frameworks?

Yes, you can generate developer docs for Phoenix frameworks. The skill analyzes diverse codebases like Phoenix to extract interfaces and produce user guides, API references, and external integration documentation.

How do I keep documentation consistent across different codebases?

You can keep documentation consistent across different codebases by applying project-specific formatting rules during generation. This automated approach ensures all inline docs, API references, and user guides follow uniform standards.

Does automated documentation generation work for both inline comments and external user guides?

Yes, automated documentation generation works for both inline comments and external user guides. It uses interface extraction and formatting rules to produce inline docstrings, API references, and onboarding tutorials.