SuperAPI AI 工具集

docs-writer

写作与研究

查看项目

更新于 10-16 05:49

技能介绍

用途:docs-writer 是 Gemini CLI 项目提供的文档写作技能,当任务涉及编写、审阅或编辑 /docs 目录下的文件或仓库中任意 .md 文件时使用。它面向技术写作与编辑,目标是产出准确、清晰、与当前代码库一致的文档。

主要能力:技能内置一套文档标准,涵盖语气与视角(以“you”称呼读者、主动语态、现在时)、语言与语法(避免拉丁缩写、使用序列逗号、明确 must 与 we recommend 的区别)、格式与语法(标题后先写概述段、80 字符换行、句首大写、项目名统一写作 Gemini CLI)、链接规范(使用描述性锚文本、文档内用相对链接、改标题时检查深链接)、结构规范(BLUF 开头、实验性功能加 NOTE、步骤用祈使动词开头、避免目录、结尾可加 Next steps)以及 callout、details 折叠块等元素用法。涉及配额与限制术语时,需遵循 quota-limit-style-guide.md。

使用方式:技能按四个阶段执行。准备阶段先澄清请求、查阅 packages/ 下相关代码、审阅 docs/ 最新文件、确认引用页面与 docs/sidebar.json 是否需要更新,并制定分步计划;执行阶段用 replace 做小改动、write_file 新建或大改文件;验证阶段检查准确性、格式与链接,必要时先运行 npm install 再执行 npm run format。若被要求审计文档,则按 docs-auditing.md 的流程进行。

适用场景:适用于 Gemini CLI 仓库内的文档新增、修订、审阅与一致性检查,也适用于需要遵循项目贡献流程(CONTRIBUTING.md)的文档改动。

限制:资料未提供该技能的安装命令、收费方式、支持平台或独立于 Gemini CLI 项目之外的使用方式;其规范与流程均针对 Gemini CLI 项目本身。