SuperAPI AI 工具集

docs-author

写作与研究

查看项目

更新于 10-16 03:14

技能介绍

用途:为项目产出用户真正能学会的文档集,按 Diátaxis 分为教程、操作指南、参考、解释四类,防止出现教程与参考混杂、按模块树而非用户任务组织导航、编造代码示例、只搭四个空目录等问题。

主要能力:先检查仓库的公开 API、现有 README/文档/wiki、issue 与支持问题,再对现有文档分模式归类;规划最小可用文档集(入门教程、真实任务的操作指南、生成的参考、1–3 个概念页、按症状排查);导航按用户任务命名、最多两层、无孤立页;每页只写一种模式;示例完整可粘贴并对照仓库源码验证;参考文档由 docstring/类型/OpenAPI 生成而非手写;同步代码变更时做漂移检查;运行 lint 脚本:python3 "${CLAUDE_SKILL_DIR}/scripts/docs_lint.py" docs。

适用场景:README 之外的项目文档内容;把过长 README 的内容迁移进 docs(README 瘦身交给 readme-author);代码变更后的文档同步。

限制与边界:README 本身、文档站点搭建部署与 CI、CONTRIBUTING/SECURITY 等社区文件、源码内 docstring 与注释均不属于本技能。文档事实无法对照代码验证时应删除或标注未验证,不得猜测;不写空页或“即将推出”页;小项目若未达导航需求阈值,一份好 README 即可。具体安装方式与收费信息暂未提供。