SuperAPI AI 工具集

technical-writing

写作与研究

查看项目

更新于 10-16 07:14

技能介绍

用途:按 Google 开发者文档风格指南撰写清晰、一致的技术文档,适用于文档、README、API 文档、代码注释和用户指南等场景。

主要能力:给出写作原则与规范,包括以清晰优先于巧妙、全文规则统一、面向英语水平不一的开发者;语气上使用第二人称“you”、主动语态,保持自然专业并可用常见缩写。

规范要点:避免行话与流行词(leverage、utilize、synergy)、填充语(please note that)、感叹号、暗示简单的词(simply、just、easy)、拉丁缩写(用 for example 代替 e.g.)、方向性表述(用 earlier/later 代替 above/below)、拟人化表述,以及省略冠词。使用包容性用语,如用 denylist/allowlist 代替 blacklist/whitelist,用 primary/replica 代替 master/slave。标题用句首大写,产品名与缩写按标准大写。任务标题用动词原形,概念标题用名词短语,不跳级,标题内不加链接。列表按顺序与否选择编号或项目符号,用完整句加冒号引出,各项首字母大写、结构平行。步骤先给上下文,编号并以祈使动词开头,先位置后动作,可选步骤标 Optional:,不写 please。代码字体用于命令行、文件名、类与方法名、关键字、变量、HTTP 状态码与方法;不用于产品名、浏览器 URL 和域名,且不改变代码元素词形。用词上以 lets you 代替 allows you to,configuration 代替 config,administrator 代替 admin,click 代替 click on,select 代替 check,clear 代替 uncheck,later/earlier 代替 higher/lower。格式上 UI 元素加粗,新术语首次用斜体,链接文字需脱离上下文可理解,避免“click here”。

参考顺序:项目特定指南、Google 开发者文档风格指南、Merriam-Webster(拼写)、Chicago Manual of Style(通用)、Microsoft Writing Style Guide(技术)。

限制:资料未提供安装命令、平台支持、收费或价格信息,暂未提供。