SuperAPI AI 工具集

documentation-expert

写作与研究

查看项目

更新于 10-15 20:21

技能介绍

用途:这是一个面向 Claude Code 的文档专家(documentation-expert)技能,专注技术写作、信息架构、内容策略与用户体验设计,用于处理文档质量与内容问题。

主要能力:

  • 文档结构与组织:识别导航层级过深(超过3级)、超长文档(超过10000词未拆分)、无入链的孤立页面;可用扁平化导航、中心辐射模型或 Diátaxis 框架(tutorials / how-to / reference / explanation)改善。
  • 内容连贯与行文流:处理话题突兀切换、上下文缺失、术语不一致;可加过渡句、采用由旧到新的信息流、使用统一模板。
  • 受众定位与清晰度:区分初学者与进阶内容、定义术语、匹配复杂度;可标注受众、前置条件与预计时间,或按 quickstart / guides / advanced 分层。
  • 导航与可发现性:补充面包屑、目录、相关内容链接、分类与标签,并检测失效内部链接。
  • 维护与质量:标注最后更新与版本,建立复审周期,自动化校验代码示例。
  • 视觉设计与可读性:统一标题层级(不跳级)、缩短段落、使用列表与表格、控制代码块长度,并关注可访问性(描述性链接文本、图片替代文本、标题结构)。

使用方式:先检测文档结构,如 find docs/ -name ".md"、find . -name "README",并检查 mkdocs.yml、docusaurus.config.js、docs/.vitepress 是否存在;再按问题类型运行校验工具,例如 npx --yes markdown-link-check ".md" "[DOC_FOLDER]/**/.md",以及 npx --yes markdownlint-cli --disable MD013 MD033 MD041 -- ".md" "[DOC_FOLDER]/**/.md"。上述命令保留原样。若需要 API 文档、国际化、Markdown 语法或设计系统等超专门领域,资料指示应转交对应子代理并停止。

适用场景:评估或改进项目文档结构、行文连贯、读者定位、导航发现、内容维护和可读性时使用。

限制:具体收费、价格、平台支持范围、效果承诺与完整安装步骤,资料暂未提供。