teachingai/documentation-builder
skills/dev-utils-skills/documentation-builder/SKILL.md
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.
$ install --global
skillsauthnpx skillsauth add teachingai/agent-skills documentation-builderInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 10, 2026, 8:43 AM5.8s1 file scanned
SKILL.md
- name:
- documentation-builder
- description:
- 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.
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
- Identify the doc type - README, API reference, user guide, developer guide, or changelog
- Gather context - Read the codebase, existing docs, and project structure
- Generate documentation - Use the templates and patterns below
- Validate - Ensure all code examples run, links resolve, and sections are complete
README Template
# 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)
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
- Start with a quick-start - Let readers get running in under 2 minutes
- Include runnable code examples - Every API endpoint or function should have a copy-paste example
- Keep docs next to code - Co-locate documentation with the source it describes
- Use consistent structure - Follow the same heading hierarchy across all doc pages
- Version your docs - Tag documentation alongside code releases
Keywords
文档编写, documentation, README, API docs, OpenAPI, Swagger, user guide, 用户手册, developer guide, 开发指南, changelog, 技术文档
Related Skills
teachingai/nextjs
development
VerifiedTrustedCommunity
Guidance for Next.js using the official docs at nextjs.org/docs. Use when the user needs Next.js concepts, configuration, routing, data fetching, or API reference details.
284SKILL.mdUpdated Apr 14, 2026
teachingai/flask
tools
VerifiedTrustedCommunity
Provides comprehensive guidance for Flask framework including routing, templates, forms, database integration, extensions, and deployment. Use when the user asks about Flask, needs to create web applications, implement routes, or build Python web services.
284SKILL.mdUpdated Apr 14, 2026
teachingai/fastapi
development
VerifiedTrustedCommunity
Provides comprehensive guidance for FastAPI framework including routing, request validation, dependency injection, async operations, OpenAPI documentation, and database integration. Use when the user asks about FastAPI, needs to create REST APIs, or build high-performance Python web services.
284SKILL.mdUpdated Apr 14, 2026
teachingai/django
development
VerifiedTrustedCommunity
Provides comprehensive guidance for Django framework including models, views, templates, forms, admin, REST framework, and deployment. Use when the user asks about Django, needs to create web applications, implement models and views, or build Django REST APIs.
284SKILL.mdUpdated Apr 14, 2026