documentation-builder
Generates structured technical documentation including API docs (OpenAPI/Swagger), README files, user guides, developer guides, and changelogs. Use when the user needs to create or improve project documentation, generate API reference docs, write onboarding guides, or structure documentation for a codebase.
Best use case
documentation-builder is best used when you need a repeatable AI agent workflow instead of a one-off prompt. It is especially useful for teams working in multi. Generates structured technical documentation including API docs (OpenAPI/Swagger), README files, user guides, developer guides, and changelogs. Use when the user needs to create or improve project documentation, generate API reference docs, write onboarding guides, or structure documentation for a codebase.
Generates structured technical documentation including API docs (OpenAPI/Swagger), README files, user guides, developer guides, and changelogs. Use when the user needs to create or improve project documentation, generate API reference docs, write onboarding guides, or structure documentation for a codebase.
Users should expect a more consistent workflow output, faster repeated execution, and less time spent rewriting prompts from scratch.
Practical example
Example input
Use the "documentation-builder" skill to help with this workflow task. Context: Generates structured technical documentation including API docs (OpenAPI/Swagger), README files, user guides, developer guides, and changelogs. Use when the user needs to create or improve project documentation, generate API reference docs, write onboarding guides, or structure documentation for a codebase.
Example output
A structured workflow result with clearer steps, more consistent formatting, and an output that is easier to reuse in the next run.
When to use this skill
- Use this skill when you want a reusable workflow rather than writing the same prompt again and again.
When not to use this skill
- Do not use this when you only need a one-off answer and do not need a reusable workflow.
- Do not use it if you cannot install or maintain the related files, repository context, or supporting tools.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/documentation-builder/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How documentation-builder Compares
| Feature / Agent | documentation-builder | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Generates structured technical documentation including API docs (OpenAPI/Swagger), README files, user guides, developer guides, and changelogs. Use when the user needs to create or improve project documentation, generate API reference docs, write onboarding guides, or structure documentation for a codebase.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
Related Guides
SKILL.md Source
## When to use this skill
Use this skill whenever the user wants to:
- Generate a project README with installation, usage, and contributing sections
- Create API documentation from code or OpenAPI specs
- Write developer onboarding or setup guides
- Build user manuals or quick-start tutorials
- Structure documentation for a new or existing project
- Generate a CHANGELOG from commit history or release notes
## How to use this skill
### Workflow
1. **Identify the doc type** - README, API reference, user guide, developer guide, or changelog
2. **Gather context** - Read the codebase, existing docs, and project structure
3. **Generate documentation** - Use the templates and patterns below
4. **Validate** - Ensure all code examples run, links resolve, and sections are complete
### README Template
```markdown
# Project Name
Brief description of what the project does and why it exists.
## Quick Start
\`\`\`bash
npm install my-package
\`\`\`
\`\`\`typescript
import { MyClient } from 'my-package';
const client = new MyClient({ apiKey: process.env.API_KEY });
const result = await client.query('hello');
\`\`\`
## Features
- Feature one with brief explanation
- Feature two with brief explanation
## Installation
Detailed installation steps for different environments.
## Usage
Detailed usage examples with code snippets.
## API Reference
Link to full API docs or inline reference.
## Contributing
How to contribute, run tests, and submit PRs.
## License
License type and link.
```
### API Documentation Pattern (OpenAPI)
```yaml
paths:
/users/{id}:
get:
summary: Get user by ID
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: User found
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'404':
description: User not found
```
## Best Practices
1. **Start with a quick-start** - Let readers get running in under 2 minutes
2. **Include runnable code examples** - Every API endpoint or function should have a copy-paste example
3. **Keep docs next to code** - Co-locate documentation with the source it describes
4. **Use consistent structure** - Follow the same heading hierarchy across all doc pages
5. **Version your docs** - Tag documentation alongside code releases
## Keywords
文档编写, documentation, README, API docs, OpenAPI, Swagger, user guide, 用户手册, developer guide, 开发指南, changelog, 技术文档Related Skills
web-artifacts-builder
Suite of tools for creating elaborate, multi-component claude.ai HTML artifacts using modern frontend web technologies (React, Tailwind CSS, shadcn/ui). Use for complex artifacts requiring state management, routing, or shadcn/ui components - not for simple single-file HTML/JSX artifacts.
mcp-builder
Guide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK).
vant-vue3
Provides structured guidance for Vant of Vue 3.0. Use when the user needs Vant with Vue 3, asks about mobile UI components such as Button, Cell, Form, Dialog, Toast, Popup, ConfigProvider, theme customization, project setup, or wants to implement mobile-first interfaces with vant or van- components.
layui-vue3
Provides comprehensive guidance for Layui Vue component library including components, layer dialogs, and utilities. Use when the user asks about Layui Vue, needs to use Layui components in Vue 3, or implement UI components.
element-plus-vue3
Provides comprehensive guidance for Element Plus Vue 3 component library including installation, components, themes, internationalization, and API reference. Use when the user asks about Element Plus for Vue 3, needs to build Vue 3 applications with Element Plus, or customize component styles.
bootstrap-vue3
Provides comprehensive guidance for Bootstrap Vue 3 component library including Bootstrap components, grid system, utilities, and Vue 3 integration. Use when the user asks about Bootstrap Vue 3, needs to use Bootstrap components in Vue 3, or implement responsive layouts.
vuex-vue2
Provides comprehensive guidance for Vuex 2.x state management in Vue 2 applications including state, mutations, actions, getters, modules, and plugins. Use when the user asks about Vuex for Vue 2, needs to manage state in Vue 2 applications, or implement Vuex patterns.
vue3
Guidance for Vue 3 using the official guide and API reference. Use when the user needs Vue 3 concepts, patterns, or API details to build components, apps, and tooling.
vue2
Provides comprehensive guidance for Vue 2.x development including Options API, components, directives, lifecycle hooks, computed properties, watchers, Vuex state management, and Vue Router. Use when the user asks about Vue 2, needs to create Vue 2 components, implement reactive data binding, handle component communication, or work with Vue 2 ecosystem tools.
vue-router
Provides comprehensive guidance for Vue Router including route configuration, navigation, dynamic routes, nested routes, route guards, programmatic navigation, and route meta. Use when the user asks about Vue Router, needs to set up routing, implement navigation guards, handle route parameters, or manage route transitions.
vue-router-v4
Provides comprehensive guidance for Vue Router v4 including route configuration, navigation, nested routes, route guards, and Vue 3 integration. Use when the user asks about Vue Router v4, needs to set up routing for Vue 3 applications, implement navigation guards, or work with Vue Router v4 features.
vue-router-v3
Guidance for Vue Router v3 using the official Installation, Guide, and API docs. Use when users need routing setup, navigation patterns, or API details for Vue 2 projects.