SuperAPI AI 工具集

google-developer-docs

编程与开发

查看项目

更新于 10-16 01:35

技能介绍

用途:起草、改写或审查开发者文档,帮助读者理解或完成技术任务,而无需费力解读文字。适用于 API 文档、概念、操作步骤、教程、参考和故障排查等页面类型。

主要能力与写作原则:保护源材料,保留事实、代码、命令、名称、URL、前置条件和约束;不臆造产品行为、默认值、兼容性或结果;缺失事实标记为问题或占位符而非猜测;项目自有术语或 API 指南优先于本风格。

规划页面:明确读者、其假定知识和所需结果;选择页面类型;把前置条件放在依赖它的首个操作之前;先给结果和最短必要背景,除非理解原因对安全或正确性必要,否则把理由放在操作之后;每个概念固定一个术语并贯穿全文。

行文:描述读者操作时用“你”;重要操作要有明确执行者和动词;执行者重要时用主动语态,仅当结果更重要或执行者未知时用被动语态;读者需先判断条件时,把条件放在指令前;每句一个主要意思,每段一个目的;首次使用定义陌生术语,不常见缩写首次展开;使用字面、全球可理解的语言,去除习语、文字游戏和文化特定比喻;当前行为用现在时,时效性说法附版本或日期;直接陈述限制,不用宣传性语言弱化。

过程写作:每步以祈使动词开头;每个编号步骤一个主要动作,其后写预期结果;上下文不清时先说明在哪里操作再命名界面控件;提供可复制命令和代码,在示例旁解释占位符;成功不可见时加验证步骤;过程创建持久资源时加清理或回滚。

排版:标题用句首大写并前置区分性词语;序列用编号列表,无序选择用项目符号;代码、命令、文件名、字面值和需输入文本用反引号;输出格式支持时用粗体表示可见界面标签;链接文字说明目的地或用途;表格或列表前加引导说明。

避免:对难度的判断词(如 simply、easily、obviously);指代不清的代词;用 allows you to 替代直接动作;不必要的 please、填充式开头和总结段;未解释的比喻、错误中的玩笑、赋予软件人类特质;为求变化而替换同一技术概念的术语。

最终检查:确认读者能识别结果、前置条件、首个操作、成功信号和下一步;删除不改变含义的词,解决歧义引用,并测试示例仍与正文一致。仅在来源、归属、许可或维护问题时可读 references/provenance.md。限制:资料未提供具体安装命令、平台支持、收费或价格信息。