Documentation Generation

Effective technical documentation strategies, API docs, README patterns, and doc generation workflows

492 stars 68 forksWriting & Content

Install

skills CLI (Claude Code, Cursor, Codex and more)
npx skills add cosmicstack-labs/mercury-agent-skills --skill documentation-generation
Manual install
git clone --depth 1 https://github.com/cosmicstack-labs/mercury-agent-skills.git /tmp/mercury-agent-skills
mkdir -p ~/.claude/skills
cp -r /tmp/mercury-agent-skills/categories/development/documentation-generation ~/.claude/skills/documentation-generation

Personal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.

From the SKILL.md

# Documentation Generation

Write documentation that people actually read, understand, and trust — with automated workflows that keep it accurate.

## Core Principles

### 1. Documentation Is Code — Treat It That Way
Store docs in the repository, version them with code, review them in PRs, lint them in CI. Documentation that lives in a separate wiki inevitably drifts from reality.

### 2. Write for the Reader's Context
Different readers need different documents. A junior developer onboarding needs a step-by-step tutorial. A senior engineer debugging needs API reference. A product manager needs architecture overviews.

### 3. Show, Don't Just Tell
Code examples are worth a thousand words of prose. Every API, every workflow, every pattern should be accompanied by a complete, runnable example.

### 4. Document Why, Not Just What
The code already tells you what it does. Documentation should explain the reasoning, the tradeoffs, and the edge cases that aren't obvious from reading the implementation.

---

## Documentation Maturity Model

| Level | Coverage | Accuracy | Tooling | Maintenance |
|-------|----------|----------|---------|-------------|
| **1: Skeleton** | README only | Often outdated | None | Never updated |
| **2: Basic** | README + setup guide | Occasionally accurate | Manual markdown | Updated for major releases |
| **3: Structured** | README + API docs + examples | Mostly accurate | Doc generators | Updated with code changes |
Read the full skill on GitHub

Details

Skill name
documentation-generation
Path
categories/development/documentation-generation/SKILL.md
License
MIT
Repo updated
25 August 2026

FAQ

What does the Documentation Generation skill do?

Effective technical documentation strategies, API docs, README patterns, and doc generation workflows

How do I install the Documentation Generation skill?

skills CLI (Claude Code, Cursor, Codex and more): npx skills add cosmicstack-labs/mercury-agent-skills --skill documentation-generation. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.

Is Documentation Generation popular?

It lives in cosmicstack-labs/mercury-agent-skills, which has 492 GitHub stars and 68 forks.

Related skills

Browse the most popular Claude skills, all writing & content skills, or write your own with the skills generator.