SuperAPI AI 工具集

docs-writer

写作与研究

查看项目

更新于 10-15 20:29

技能介绍

用途:docs-writer 是一个技术写作与编辑技能,目标是产出并完善准确、清晰、一致、易于用户理解的文档,并遵循 CONTRIBUTING.md 中的文档贡献流程。

主要能力与流程:

  1. 理解目标并制定计划:明确用户请求,识别需要处理的核心功能、命令或概念;区分是撰写新内容还是编辑现有内容;若请求含糊(如“修一下文档”),先向用户澄清;随后制定清晰的逐步计划。
  2. 调研与收集信息:阅读相关代码库(主要在 packages/ 目录)以确保内容有实现支撑并发现缺口;在 docs/ 目录定位需修改的具体文档文件,动手前先读最新版本;检查关联文档,例如修改命令行为时检查其他引用页面,新增页面时检查 docs/sidebar.json 是否需要更新,并确保所有链接最新。
  3. 撰写或编辑:遵循 references/style-guide.md 中的风格指南;确保新文档准确反映代码中的功能;使用文件系统工具应用改动,小改动优先用 replace,新文件或大段重写用 write_file。编辑现有文档时,找出不完整或与代码不符之处,保持主动、有吸引力的语气,修正措辞、拼写和语法,统一术语与风格。
  4. 验证与收尾:改完后重读文件,确认格式良好、内容与现有代码一致;验证新内容中所有链接的有效性,以及指向新增或删除内容页面的既有链接;全部完成后,可提议运行项目格式化脚本,命令为:npm run format。

适用场景:需要为代码库撰写新文档、修订过时文档、统一术语与风格、检查文档链接与侧边栏配置时。

限制:资料未提供该技能的具体安装方式、支持平台、收费情况或效果数据;其流程依赖项目内 CONTRIBUTING.md、references/style-guide.md、packages/ 与 docs/ 等目录结构。