mcpField
S
simple-english

simple-english

github.com/vinta文档处理14259 次安装今天更新
代码仓库

关于 simple-english

用于将文本改写为面向全球读者的英语,同时保留技术含义、事实和原有语气。适合撰写清晰、便于翻译的文档,并提供逐句流程和核查清单。

主要功能

  1. 01保留原文事实与限定条件
  2. 02采用清晰且便于翻译的表达
  3. 03保持代码和标识符不变
  4. 04检查术语与句子清晰度
  5. 05报告歧义和信息缺口

适用场景

  1. 01改写技术文档
  2. 02让文本更易于全球读者理解
  3. 03检查术语一致性
  4. 04标记源文本的信息缺口

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/vinta/hal-9000 --skill simple-english

安装后在 Claude Code 中输入/simple-english确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

agents/
openai.yaml
references/
README.md
writing-rules.md

详细介绍

简明英语

用全球通用英语撰写或改写给定文本:这种英语面向全球读者,也是 Google、Microsoft、MDN、Red Hat 和 GitLab 文档所采用的英语。结构清晰,用词明确,语法便于翻译;不使用受控词典,也不设严格的词数上限。改写后的文本必须保留原文的技术事实,同时读起来自然流畅。

基本规则

  • 含义不可更改。 原文中的每项事实、数值、条件和限定都必须保留。弱化的义务语气也要保留:“should” 仍表示建议,除非原文表达的是要求。
  • 绝不编造具体信息。 保持每项事实原有的精确度,并指出信息缺失之处。不要编造数值、名称或条件。
  • 引用文本保持不变。 代码片段和代码块、命令、配置项、文件路径、界面标签、错误消息和标识符都必须原样保留。改写其周围的说明文字。
  • 保留原有语气。 如果清晰度编辑把文章改得像一连串生硬的短句,那就是退步。可随意删去填充语(例如“需要注意的是”),但要保留个性。

工作流程

  1. 了解规则。 完整阅读 references/writing-rules.md:句子结构、用词、清晰度辅助规则、语气和替换表。

  2. 收集原文。 使用对话中的文本,或读取用户指定的文件或章节。如果用户要撰写新文本,而不是改写现有文本,则从对话、代码或文件中收集需要陈述的事实,并在后续每一步中将这些事实作为原文依据。完成标准:掌握所有需要改写的段落或需要陈述的事实。

  3. 对每段内容进行分类,归为步骤(祈使式操作步骤)、说明(陈述性文字)或微文案(标题、界面标签、错误消息)。步骤使用祈使语气,并将条件置于前面。必要时,为微文案添加动词以提高清晰度。

  4. 统一术语。 列出以多个名称出现的概念,为每个概念选定一个术语(优先使用项目中已有的名称),并在全文中保持一致。完成标准:每个概念只有一个名称,每个词也只表达一种含义。

  5. 逐句改写。 使用主谓宾结构,让主语尽早出现;每句只表达一个意思;采用主动语态和现在时;将条件置于前面;保留简短词语(如 “that”、“who” 和冠词);将可能有多个指代对象的代词替换为其所指的名词;将包含两个以上修饰语的名词堆叠拆开;明确隐藏的动词(使用 “install”,而不是 “perform an installation”);根据替换表替换习语和冗长的短语动词。Kohl 的首要规则决定每一处编辑:任何改动都不能让母语者觉得不自然。

  6. 根据检查清单核对每段和每句:

    • 每段只讨论一个主题,并在首句说明重点。
    • 主语和动词尽早出现;关联分句不超过三个;句首不使用 “there is/are” 结构。
    • 步骤使用祈使语气,并将条件置于前面。
    • 每个代词的指代对象都明确;每个缩写都在首次出现时定义。
    • 术语与第 4 步的术语表保持一致;并列的意思采用平行结构。
    • 不使用习语、文化特定的说法、拉丁文缩写或方向性指引(如 “above”、“below”)。
    • 句子朗读起来依然自然流畅。

    完成标准:每句话都符合要求;若有意偏离,必须在报告中说明。

  7. 交付。 提供改写文本。只有在用户要求修改文件时,才直接编辑文件。改写后,只报告适用的内容:

    • 术语表,供用户审核术语选择。
    • 对原文含义的判断,以及改写时采用的解释。
    • 原文缺少且读者需要的信息。

评论

支持 Markdown