documentation

Generate and update code, API, architecture, and user documentation.

53|1|Updated Dec 18, 2025
One-click install
npx skills add https://github.com/cosmix/claude-code-setup --skill documentation-cosmix
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/cosmix/claude-code-setup/tree/main/skills/documentation
Command: npx skills add https://github.com/cosmix/claude-code-setup --skill documentation-cosmix

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill focuses on producing well-structured documentation, API references, architecture diagrams, and user guides to reduce cognitive load and support adoption.

Core Features & Use Cases

  • Code Documentation: Inline docs, API references, and usage examples.
  • Architectural Docs: System overview, data flows, and deployment considerations.
  • Documentation Hygiene: Templates, versioning, and keeping docs in sync with code.

Quick Start

Draft a concise API reference for a newly added endpoint including request/response examples.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I add JSDoc and inline documentation to my codebase?

JSDoc documentation automates the creation of inline code comments that document parameters, return values, and types. This Skill generates JSDoc blocks for functions and methods, reducing manual annotation work and ensuring consistent parameter and exception documentation across your codebase.

What's the best way to generate API documentation from code?

API documentation generation extracts type information, parameters, return values, and usage examples directly from your code to produce reference docs automatically. This Skill creates comprehensive API references that stay synchronized with code changes, eliminating manual update cycles.

How do I keep documentation in sync with code changes?

Documentation hygiene enforces templates, versioning, and automated consistency checks to prevent drift between docs and implementation. This Skill identifies outdated content, updates diagrams and deployment notes, and maintains a single source of truth as your codebase evolves.

Can I generate architecture documentation and system diagrams automatically?

Architecture documentation creation produces system overviews, data flows, and deployment diagrams alongside code docs. This Skill generates these artifacts to help teams understand system design without manual diagram maintenance.

Do I need to write README and user guide content manually?

User guides and README files can be structured and partially generated from your code documentation, type information, and usage examples. This Skill creates maintainable user guides by pulling from existing documentation and enforcing consistent templates across your projects.