SuperAPI AI 工具集

google-devdocs-style

编程与开发

查看项目

更新于 10-15 21:38

技能介绍

用途:按 Google 开发者文档风格撰写或审校开发者文档,如指南、API 参考、README、操作步骤、发布说明。目标是让读者一次读懂:知道谁做什么、按什么顺序、接下来发生什么;风格是规定性的,倾向于推荐一条路径而非罗列所有选项。

主要能力与规则:冲突时优先级为用户明确要求与目标平台要求、源事实(引用、代码、命令、文件名、API 名、UI 标签、产品名、版本号必须保持原样)、项目风格(该仓库以 AGENTS.md 为准,禁止 U+2014 与 U+2013 破折号)、本文件规则、references/ 与在线指南。核心要求包括:保真优先,保留作者的确定程度与所有限定条件;不改链接目标只改锚文本;不编造产品行为;条件写在指令之前;以“你”称呼读者,步骤用祈使句;命名行为主体并用主动语态;用现在时;区分必须、建议、可选;删去“简单、快速、无缝”等夸大词;“当前、现在、最新”等时间锚点要删(发布说明等体裁豁免);标题用句式大小写;链接文本可独立理解;代码字体与粗体区分;占位符用 UPPER_SNAKE_CASE 并在代码块后解释;列表类型与内容匹配;每步一个动作;为非英语母语读者写作;使用无障碍与包容性表述;避免拟人化;机械规则包括序列逗号、美式拼写、数字拼写等。

使用方式:先明确读者、目标、文档类型及任务是起草、修订还是审计;标记不可漂移的内容;先写结果或目的;按规则起草;在 references/ 中查找具体条目;最后运行检查清单与逐行保真核对。

限制:references 为综合整理而非原文复制,未核对在线指南前不应声称完全符合;用户要求审计时不改写,应按优先级报告发现;不将文档规范强加于引用、代码、法律文本或刻意的个人语气;官方文本暂未提供。