菜单
编写清晰的技术文档：README、API、教程、变更日志，并规范 README 的 Shields.io 徽章与顶部排版。当用户要求写文档、写 README、修改 README 徽章、文档化接口、写教程、写发布说明，或提到 docs、documentation、README、badge、shields、tutorial、changelog、release notes 时使用。
默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。
决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
直接命令不会经过审查 Prompt；运行前请先检查来源。
npx skills add https://github.com/xiongxianzhu/xskills --skill docs-writer命令会保持在同一行。复制前请横向滚动并检查完整内容。
想先保存到本地？可下载 SkillsMP 当前能够提供的文件。
正在显示 SKILL.md
| name | docs-writer |
| description | 编写清晰的技术文档：README、API、教程、变更日志，并规范 README 的 Shields.io 徽章与顶部排版。当用户要求写文档、写 README、修改 README 徽章、文档化接口、写教程、写发布说明，或提到 docs、documentation、README、badge、shields、tutorial、changelog、release notes 时使用。 |
按五原则与四类文档最小结构，产出可扫描、带可运行示例的 Markdown 文档。规则与模板见 references/style-guide.md 与 references/templates.md。
api-docs（本仓库）prd-creator（本仓库）| 原则 | 要点 | 反例 |
|---|---|---|
| 目标先行 | 先答"为什么用"，再讲"怎么用" | 开头堆功能列表 |
| 示例胜过描述 | 每个概念配可运行代码 + 预期输出 | 只写文字不演示 |
| 渐进披露 | Quick Start 在前，深潜在后；复杂主题用链接隔离 | 一上来铺全部配置 |
| 可扫描 | 描述性标题、3 项以上用列表、代码加语言标签 | 大段无层级散文 |
| 主动 + 现在时 | "运行 X 返回 Y"，不是"X 被运行后 Y 被返回" | 被动语态连串 |
按读者意图选型，而非按内容罗列：
| 读者想… | 文档类型 | 最小结构见 |
|---|---|---|
| 评估/上手项目 | README | README 模板 |
| 调用接口/函数 | API 文档 | API 文档模板 |
| 跟着做完成一个任务 | 教程 | 教程模板 |
| 了解版本变化 | 变更日志 | 变更日志模板 |
| 理解概念/设计 | 解释性文档 | 用 README 或独立文章，遵循同样五原则 |
处理目标文件名为 README.md 的任务时，必须读取 README 模板 和 README 头部与徽章，再按以下顺序执行：
img.shields.io 图片 URL。style 参数新增或替换为 for-the-badge，保留其他参数、图片文本和链接目标。<div align="center">，避免嵌套或重复元素。README 以外的文档不自动应用上述徽章规则，除非用户明确要求。
执行者与验收者分离：写产出的 Agent 不得在无约束下自判「已完成」。
| 角色 | 说明 |
|---|---|
| 执行 | 主 Agent 按工作流程产出 |
| 验收 | 对照 style-guide.md 的反模式清单 逐项校对；至少抽检 1 个代码示例的可运行性 |
验收不通过时：带着具体错误信息修正，进入下一轮（见下方停止条件）。
| 类型 | 上限 |
|---|---|
| 自修订迭代 | 单文档最多 3 轮 |
| Token / 成本 | 单任务预算上限（按你的工具设定） |
| 时间 | 单次运行不超过 N 分钟 |
任一条件触达即停止，汇总当前进度交人工处理。
