docs-agent skill
Write, update, and audit product, technical, and operational documentation using various reference sources and templates.
- GitHub stars
- 7
- Files
- 6
- Last commit
- Sep 14, 2026
- License
- MIT
- Allowed tools
- —
What does the docs-agent skill do?
docs-agent is an agent skill. Write, update, and audit product, technical, and operational documentation using various reference sources and templates.
Summary generated from the skill's SKILL.md.
About the docs-agent skill
Writing, updating, and auditing product, technical, and operational documentation is the primary function of this skill. It serves developers and technical writers who need to maintain accurate manuals, release notes, and interface specifications. An agent should load this skill when it needs to transform user requests, issues, implementation details, or test results into structured documentation. It produces files or site entries based on existing templates and frontmatter contracts.
The skill integrates with several specialized tools to handle specific documentation workflows. It can initialize documentation scaffolding, synchronize facts across product designs and databases, generate illustrated manuals, and create release notes. It also performs audits to verify document facts, links, and versions. Users can provide existing documentation locations or templates as reference points, and the agent can combine various professional knowledge sources to ensure the output meets reader requirements.
What an agent can do with it
- 1Initialize documentation sitesSet up a new documentation scaffolding structure for a project.
- 2Synchronize technical factsEnsure product designs, interfaces, and databases are accurately reflected in the documentation.
- 3Audit documentation accuracyVerify that all links, versions, and facts within the documentation are correct.
Written from the skill's SKILL.md. Every use case is checked against a quote from it.
How to install the docs-agent skill
Each command copies the skill folder into the client's skills directory. Restart the client or start a new session to load it.Install the docs-agent skill in Plugin
/plugin marketplace add Neplich/dev-agent-skills /plugin install docs-agent@dev-agent-skills
Install the docs-agent skill in Claude Code
~/.claude/skills/docs-agent/SKILL.md
$ npx degit Neplich/dev-agent-skills/agents/docs/skills/docs-agent ~/.claude/skills/docs-agentInstall the docs-agent skill in Claude Code (project)
.claude/skills/docs-agent/SKILL.md
$ npx degit Neplich/dev-agent-skills/agents/docs/skills/docs-agent .claude/skills/docs-agentInstall the docs-agent skill in Codex
~/.agents/skills/docs-agent/SKILL.md
$ npx degit Neplich/dev-agent-skills/agents/docs/skills/docs-agent ~/.agents/skills/docs-agentInstall the docs-agent skill in Gemini CLI
~/.gemini/skills/docs-agent/SKILL.md
$ npx degit Neplich/dev-agent-skills/agents/docs/skills/docs-agent ~/.gemini/skills/docs-agentInstall the docs-agent skill in Claude.ai
npx degit Neplich/dev-agent-skills/agents/docs/skills/docs-agent docs-agent && zip -r docs-agent.zip docs-agent # claude.ai → Customize → Skills → + → Create skill → Upload a skill → docs-agent.zip
SKILL.md
View on GitHub文档能力入口
围绕读者任务和当前事实完成文档工作。用户请求、issue、实现、测试、界面与已有资料均可提供起点;当前助手按需要组合写作、实现和验证能力。
| 任务 | 参考 |
|---|---|
| 初始化或更新文档站脚手架 | docs-site-bootstrap |
| 同步产品、设计、接口、数据库与运维事实 | formal-docs-sync |
| 图文操作手册 | manual-gen |
| 站内发布说明 | release-notes-gen |
| 文档事实、链接与版本核对 | docs-audit |
根据任务使用宿主已有文档位置、模板和验证方式。独立文档与现有站点都可以交付;需要站点能力时使用脚手架资料。专业知识来源可以组合使用,授权持续适用。面向读者的长文可结合 human-writing 方法。
站点页面字段见 frontmatter-contract.md。完成后提供文件或站点入口、验证结果及影响使用的限制。
Files in this skill
6docs-agent skill questions
How do I install the docs-agent skill in Claude Code?
Run npx degit Neplich/dev-agent-skills/agents/docs/skills/docs-agent ~/.claude/skills/docs-agent. Claude Code loads skills from ~/.claude/skills (all projects) or .claude/skills (one project) and uses a skill when its description matches the task.
Which clients can use the docs-agent skill?
Any client that reads the Agent Skills format: Claude Code, Codex, Gemini CLI and claude.ai (upload as a ZIP). Scripts in the skill run only where the client allows code execution.
What types of documentation can this agent handle?
The agent can write, update, and check product, technical, operations, manuals, and release documentation.
Can the agent create illustrated operation manuals?
Yes, the agent has a specific capability for generating manuals with text and images.
How does the agent ensure documentation accuracy?
The agent can perform audits on documentation facts, links, and versions.