SuperAPI AI 工具集

simple-english

写作与研究

查看项目

更新于 10-16 05:29

技能介绍

Simple English 是一个技术写作技能,目标是用 ASD-STE100 简化技术英语的规则来编写或改写技术文本,使内容清晰、无歧义,并消除 AI 生成文本的常见特征,例如长句、同义词轮换、模糊限定、填充词和装饰性从句。

用途 该技能面向技术事实与指令类文本。资料明确说明,不要把它用于营销文案、博客语气或品牌写作,因为它会按设计删除说服性内容。

主要能力 技能提供两种模式:务实模式(默认)适用于文档、README、错误信息等需要清晰文本的场景,应用全部结构性规则,领域词保留;严格模式在用户明确提到 STE、ASD-STE100 或合规要求时使用,除结构性规则外还要求完整的词汇纪律,并告知用户完全合规需要官方词典(可在 asd-ste100.org 免费获取)。

技能要求先对文本分类:程序性文本用于告诉读者做什么,使用祈使句,每句最多 20 词,每句一个指令;描述性文本用于解释事物是什么或做什么,使用一般现在时、过去时或将来时,每句最多 25 词,每段一个主题且最多六句。两类文本不得混用。

规则目录共 53 条,分为 9 个章节,依据 ASD-STE100 第 9 版改写并配有软件示例:

第 1 节 用词(1.1-1.14):只使用批准词、技术名词或技术动词;批准词只能按其列出的词性使用;只能按其批准含义使用;只使用动词和形容词的批准形式;领域词可作为技术名词;未批准词仅可作为技术名词或其中一部分;不得把技术名词用作动词;使用项目或行业的技术名词;选择简短清晰的技术名词;不得使用地区、俚语或行话作为技术名词;一项事物一个名称;领域动词可作为技术动词;不得把技术动词用作名词;使用美式英语拼写。

第 2 节 多词名词(2.1-2.2):多词名词不超过三个词;超过三个词时先写全称,再给简称或用连字符连接单元;用介词打断长名词链。

第 3 节 动词(3.1-3.7):只使用词典给出的动词形式;只使用不定式、祈使式、一般现在时、一般过去时、一般将来时、作形容词的过去分词;过去分词只作形容词;不用助动词构成复杂结构,不用现在完成时,不用“is to be installed”;-ing 形式只作技术名词或其中一部分,不作动词;使用主动语态,描述性文本中仅当施动者未知时可用被动;用动词而非名词描述动作。批准的情态动词为 can、will、must;禁用 should、would、may、might、could。

第 4 节 句子(4.1-4.5):写简短清晰的句子;不得为缩短句子而省略词或使用缩写,保留冠词和 that;复杂文本使用垂直列表;相关主题的句子之间使用连接词;名词前加冠词或指示形容词。

第 5 节 程序性写作(5.1-5.5):每句最多 20 词,含警告和注意;每句一个指令,除非两个动作同时发生;指令用祈使句;必需条件放在命令之前并用逗号分隔;注释只给信息,不给指令,注释适用 25 词限制。

第 6 节 描述性写作(6.1-6.6):逐步给出信息,每句一个新事实;用关键词和短语建立逻辑结构;每句最多 25 词;把相关信息归入段落;每段一个主题;每段最多六句。描述性文本中不得使用祈使句。

第 7 节 安全指令(7.1-7.3):用词表明风险等级(WARNING 表示伤害,CAUTION 表示损坏);以清晰的命令或条件开头;然后给出风险或可能结果。不得把指令埋在解释之后。

第 8 节 标点与字数(8.1-8.7):除分号外所有标准标点均可用,分号处改写为两个句子;用连字符连接作为一个单元的词;括号可用于引用、项目编号、缩写、复数形式、解释、替代项;垂直列表中,引导冒号结束句子并计入字数;括号内文本计为一个词;数字、带单位数字、缩写、字母数字标识符、引用文本、标题、标签、专有名词各计为一个词;连字符词计为一个词。

第 9 节 写作实践(9.1-9.4,GR-1 至 GR-8):逐词替换不奏效时重构句子;正确使用每个批准词;不得构成短语动词;全文保持一致的风格和术语。一般建议包括保留连词 that、谨慎使用 with、代词指代明确、优先使用“this + 名词”而非单独的 this、避免假朋友、避免拉丁缩写、使用包容性语言、仅在确定正确时使用所有格撇号形式。

使用方式 技能要求:选择模式;把每段文本分类为程序性或描述性;起草前固定词汇,为 check/verify/confirm/validate 概念只选一个动词,为 config/settings 概念只选一个名词,全文不再使用其他词;套用规则目录;交付前执行自检;不得改动代码、标识符、命令或引用的错误信息。当被要求检查文本而非编写文本时,按“规则编号、违规文本、合规改写”报告,且只能引用本文件中存在的规则编号。

技能还提供词汇纪律说明、已知词性裁定示例、情态动词阶梯、AI 套话替换表、一致性检查方法,以及不可改动清单:代码块、行内代码、标识符、CLI 命令、标志、文件路径、引用的错误信息和日志行、产品名称、API 端点名称、配置键、带单位数字。

适用场景 资料列出:错误信息、运行手册、事故报告、发布说明、智能体指令(提示词、AGENTS.md)、翻译准备。

限制 STE 面向技术事实与指令,不适用于营销文案、博客语气或品牌写作。官方词典约 900 个批准词、约 1200 个禁用词及替代词,受 ASD 版权保护,本技能未复制;完全合规需要官方词典。