documentation-specialist
文档专家。专注于技术文档编写、API 文档生成、README 优化和文档维护。提供清晰的文档结构、规范的格式和用户友好的内容。
Best use case
documentation-specialist is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
文档专家。专注于技术文档编写、API 文档生成、README 优化和文档维护。提供清晰的文档结构、规范的格式和用户友好的内容。
Teams using documentation-specialist should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/documentation-specialist/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How documentation-specialist Compares
| Feature / Agent | documentation-specialist | 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?
文档专家。专注于技术文档编写、API 文档生成、README 优化和文档维护。提供清晰的文档结构、规范的格式和用户友好的内容。
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.
SKILL.md Source
# Documentation Specialist - 文档专家 目标:写出“可用、可维护、可验证”的技术文档,让用户能独立完成安装/使用/排错,让维护者能追溯变更与接口契约。 为满足社区推荐的 `SKILL.md` 500 行以内约束:长模板(README/OpenAPI/Sphinx/JSDoc 示例等)已下沉到 `awesome-code/agents/documentation-specialist/references/legacy-skill-full.md`。 ## 何时使用 - 需要编写/重构 README、用户指南、开发者指南 - 需要生成/校正 API 文档(OpenAPI/Swagger) - 需要把“隐含规则”变成可执行的文档约束与示例 ## 输入 - 目标读者:用户 / 开发者 / 运维 - 当前状态:现有文档、接口、CLI 参数、默认配置 - 约束:目录结构、命名规范、版本来源(如 config.yaml) ## 输出 - README(快速开始 + 常见问题 + 约束/边界) - API 文档(请求/响应 schema、错误码、示例、鉴权) - 文档质量检查清单(可用于审查) ## 写作规则(优先级从高到低) 1. 正确性:与代码/配置一致;不写“猜测性承诺” 2. 可操作性:每一步都能照做(命令/路径/输入输出清晰) 3. 最小惊讶:默认行为符合直觉;不隐藏破坏性行为 4. 可维护:模板化结构 + 单一真相来源(例如版本号只在 config.yaml) ## 最小文档结构(推荐) - What:它是什么,解决什么问题 - Quickstart:最短路径跑通 - Usage:常用用法与参数 - Outputs:输出文件/目录约定 - Troubleshooting:常见错误与定位 - Contributing(可选):开发/测试/发布
Related Skills
reviewing-documentation
Use when reviewing documentation quality, auditing README or CLAUDE.md files, or standardizing AI instruction files.
research-documentation
Searches across your Notion workspace, synthesizes findings from multiple pages, and creates comprehensive research documentation saved as new Notion pages. Trigger on "노션 검색", "조사해줘", "리서치 정리". For meeting prep use meeting-intelligence; for saving knowledge use knowledge-capture; for spec breakdown use spec-to-implementation.
quality-documentation-manager
Document control system management for medical device QMS. Covers document numbering, version control, change management, and 21 CFR Part 11 compliance. Use for document control procedures, change control workflow, document numbering, version management, electronic signature compliance, or regulatory documentation review.
documentation-templates
Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.
documentation-structure-validator
Validate documentation structure, check for missing sections, verify markdown syntax, ensure consistency with templates. Use when user mentions docs validation, structure check, README review, documentation quality, or wants to verify documentation completeness.
documentation-standards
Clear technical documentation with JSDoc, READMEs, Mermaid diagrams, ISMS policy references, and comprehensive code examples
documentation-research
Enforces documentation research before implementation. Auto-loads when implementing features to ensure current best practices are followed. Researches official docs first.
documentation
Technical writing, API docs, and documentation best practices
Documentation Hygiene
This skill should be used when the user asks to perform "documentation hygiene", "update docs for change", "mark historical docs", "add deprecation headers", "documentation migration", or when making significant changes that affect multiple documentation files (like license migrations, tier changes, or API changes).
documentation-guidelines
Write or update backend feature documentation that follows a repo's DOCUMENTATION_GUIDELINES.md (or equivalent) across any project. Use when asked to create/update module docs, API contracts, or backend documentation that must include architecture, endpoints, payloads, Mermaid diagrams, and seeding instructions.
documentation-generation-doc-generate
You are a documentation expert specializing in creating comprehensive, maintainable documentation from code. Generate API docs, architecture diagrams, user guides, and technical references using AI...
create-oo-component-documentation
Create comprehensive, standardized documentation for object-oriented components following industry best practices and architectural documentation standards.