用途:docs-writer 是 Gemini CLI 项目的技术写作与编辑技能,在需要编写、编辑或审阅 /docs 目录及仓库内 .md 文件时使用,产出准确、清晰、一致的文档,并遵守 CONTRIBUTING.md 的贡献流程。
主要能力与标准:采用专业且友好的对话式语气,以“you”称呼读者,使用主动语态和现在时;使用简单词汇,避免行话、俚语和营销话术;使用标准美式英语,避免习语和文化引用;明确区分必须(must)与建议(we recommend),避免使用 should;避免 please 和拟人化表达,可使用缩写。语言上避免拉丁缩写,用 for example 和 that is;使用序列逗号,句号与逗号置于引号内;日期使用无歧义格式;用 lets you 替代 allows you to,使用精确动词;示例用有意义名称,避免 foo、bar 等占位符。涉及配额或限制内容时遵循 quota-limit-style-guide.md,quota 指管理配额桶,limit 指数值上限。
格式与结构:每个标题后先写至少一段概述再列列表或子标题;正文在 80 字符处换行(长链接和表格除外);标题、标题名和加粗文本使用句子大小写;项目统一称为 Gemini CLI(不加 the);顺序步骤用编号列表,非顺序内容用项目符号列表,列表项结构保持一致;UI 元素用加粗,文件名、代码片段、命令和 API 元素用代码字体;链接使用描述性锚文本,避免 click here;语义化使用标题、列表、表格等元素;媒体文件名使用小写连字符,并为图片提供描述性替代文本。开头用导语说明预期内容;实验性功能在导语后加备注说明该功能处于预览开发中;用层级标题组织用户路径;过程列表前用完整句子引入,每步以祈使动词开头,先写条件再写指令,说明操作发生的位置,明确标注可选步骤;使用项目符号列表、表格、备注和警告;移除目录;适用时以“Next steps”结尾。
使用方式:先澄清请求,区分新写与编辑,含糊请求需询问;检查相关代码(主要在 packages/)以保证准确;阅读 docs/ 中最新文件;确定所有引用页面,必要时更新 docs/sidebar.json;制定分步计划。执行时用 replace 做小幅编辑,用 write_file 创建新文件或大规模重写;编辑现有文档时识别缺口,套用新文档结构规则,若修改标题需更新指向该标题的链接,检查语气、清晰度和术语一致性。最后做质量检查:确认内容与实现一致,自查格式与行文,检查新增与现有链接,修改标题后更新相关链接,完成后询问是否执行 npm run format,用户确认后执行。
适用场景与限制:适用于 Gemini CLI 项目的 /docs 目录和 .md 文件写作、评审与编辑。限制:该技能面向特定项目文档,其语言、格式和流程规则来自项目资料;资料未提供收费、价格、平台等信息;除已列规则外,其他功能暂未提供。