documentation

Generate and refine technical documentation, including code comments and API references.

Updated Mar 13, 2026
One-click install
npx skills add https://github.com/kirvin/copilot-cli-essentials --skill documentation-kirvin
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/kirvin/copilot-cli-essentials/tree/main/plugins/cpe/skills/documentation
Command: npx skills add https://github.com/kirvin/copilot-cli-essentials --skill documentation-kirvin

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the creation and improvement of all forms of documentation, from inline code comments to comprehensive system architecture guides, ensuring clarity and maintainability.

Core Features & Use Cases

  • Code Comment Auditing: Analyzes and refactors inline code comments for clarity and necessity.
  • System Documentation Generation: Creates or updates READMEs, API documentation, and architecture diagrams.
  • Use Case: You've just finished a complex feature and need to document it. Use this Skill to generate API docs for the new endpoints, update the system architecture diagram, and ensure all code comments clearly explain the 'why' behind the implementation.

Quick Start

Use the documentation skill to generate API documentation for the file src/api/users.ts.

Frequently Asked Questions about documentation

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

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

To generate API documentation, this Skill analyzes your source files, extracts endpoint definitions, and produces structured API references. It supports various file types and routes the task to appropriate agents to ensure the output adheres to progressive disclosure and task-oriented writing principles.

What is the best way to write code comments that explain the 'why' behind implementation?

Writing effective code comments requires focusing on the reasoning behind decisions rather than restating logic. This Skill audits and refactors inline comments for clarity and necessity, ensuring they communicate the implementation's purpose and maintainability.

Can I create system architecture diagrams and overviews from source code?

You can create system architecture diagrams and overviews by routing your source files to the system-level documentation agents. This Skill generates or updates comprehensive architecture guides and READMEs to map out complex features and system structures.

Does this documentation tool support progressive disclosure for technical writing?

This documentation tool fully supports progressive disclosure by structuring technical writing into layered, task-oriented formats. It ensures complex system overviews and API references are organized so users can navigate from high-level summaries to detailed implementation specifics.

When should I use an automated tool for README generation versus writing it manually?

Automated README generation is ideal when you finish a complex feature and need to rapidly update system documentation without manual overhead. Use it to ensure consistent structure, progressive disclosure, and immediate alignment with the latest codebase changes.