SuperAPI AI 工具集

cursor-technical-writing

写作与研究

查看项目

更新于 10-16 05:52

技能介绍

用途:为技术文档、PR 描述和提交信息提供统一写作标准,目标是让疲惫的工程师第一遍就能读懂。写作分四层,每层回答一个问题:这是什么类型的文档、句子如何称呼读者、每个句子承载多少信息、句子是否可能被读出两种含义。

主要能力: 一是 Diátaxis 模式选择。一篇文档只用一个模式:教程(动手学习)、操作指南(达成目标)、参考(查阅事实)、解释(理解原因)。不要混用模式,应拆分并链接。 二是句子面向读者。用“you”和现在时,说清谁做什么,指令写成命令句,条件放在指令前,先说常见情况。标题要带观点而非只写主题,链接文字说明去向而非“点击这里”。 三是 STE 规则控制负载。一句一个指令、一个想法,过长句子拆分,警告和条件放在被保护的步骤前,保留冠词与连接词。 四是 Global English 消除歧义。“only”“not”贴近所修饰词,拆开长名词串,代词指向明确,不省略动词,用句号代替分号,不用斜杠,每个事物全篇统一名称。 此外还有三条通用规则:删掉不干活的词,使用简短日常词,规则若让句子更糟就换种改法。代码库即词表,写真实符号、文件、参数或命令名,不要生造术语。还要有意变换句子长短,在允许的模式里表达观点。

使用方式:将本技能应用于它接触的每一份文档,并配合 cursor-unslop 技能,后者负责 AI 词汇、填充语、对冲语和格式痕迹。使用前需检查已发布的同名依赖;若不可用,应报告依赖并将纯文字结果标注为不完整。review_prose 工具只检查有限规则形态,不覆盖组合工作流。PR 描述与提交信息除 Diátaxis 外同样适用全部规则,但不要粘贴日志、SHA 列表或指标表,改为链接。

适用场景:技术文档、操作指南、参考手册、解释性文章、PR 说明和提交信息。产品 UI 文案不适用,应使用产品自身的文案规范。

限制:资料未提供安装命令、版本、收费或平台信息。部分细节仅来自该技能描述,实际使用请以官方页面为准。