用途:该技能用于撰写、编辑、审阅文档,主要面向 /docs 目录及 .md 文件,目标是为 Gemini CLI 项目产出准确、清晰、一致的文档,并保证内容与当前代码库一致。使用时还应遵循 CONTRIBUTING.md 中的贡献流程。
文档规范:采用专业且友好的语气,以“you”称呼读者,使用主动语态和现在时;用标准美式英语,避免行话、俚语、营销宣传与文化引用;区分“must”与“we recommend”,避免“should”,避免“please”和拟人化,可使用缩写。语言上避免拉丁缩写,用“for example”“that is”;使用连续逗号;日期采用无歧义格式;使用精确动词;示例使用有意义名称而非占位符。格式上,每个标题后先写概述段落;正文 80 字符换行(长链接和表格除外);标题、标题文本、加粗文本使用句首大写;统一称项目为 Gemini CLI;顺序步骤用编号列表,否则用项目符号列表;UI 元素加粗,文件名、代码片段、命令和 API 元素用代码字体;链接使用描述性锚文本;正确使用语义化 HTML;媒体文件名使用小写连字符并配描述性替代文本。结构上采用 BLUF 开头,实验性功能在简介段后加指定提示,使用层级标题,流程步骤以完整句子引入、以祈使动词开头,条件写在指令前,可选步骤明确标注,使用列表、表格、提示和警告,删除目录,适用时以“Next steps”结尾。
使用流程:准备阶段先厘清请求(区分新建与编辑,含糊时请求澄清),检查 packages/ 下相关代码,审阅 docs/ 最新文件,变更行为时找出所有引用页并检查 docs/sidebar.json 是否需要更新,制定分步计划。执行阶段用文件系统工具更新或创建文件,小改动用 replace,新文件或大改写用 write_file;编辑现有文档时识别缺口、套用结构规则、修正语气语法、统一术语。验证阶段核对准确性、自查格式与行文、检查链接,最后询问是否执行 npm run format,用户确认后执行该命令。
适用场景与限制:适用于 Gemini CLI 项目文档写作、审阅、编辑及相关 .md 文件维护。资料未提供官方公开说明、价格、平台或效果等信息,暂未提供。