SuperAPI AI 工具集

docs-writer

通用与其它

查看项目

更新于 10-15 22:10

技能介绍

docs-writer 是一个技术写作与文档编辑技能,目标是产出并打磨准确、清晰、一致、易读的文档,并要求遵循 CONTRIBUTING.md 中规定的文档贡献流程。

用途:撰写新文档或编辑已有文档;审阅 Markdown 文件;在代码变更后同步更新文档,保持文档与实现一致。

主要能力与工作方式(按四个步骤):

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

适用场景:项目文档的持续维护、代码改动后的文档同步、Markdown 审阅与润色。

限制:资料未提供安装方式、收费与价格、支持的平台、命令行工具本身的详细参数,以及该技能的具体运行环境要求,这些信息暂未提供。