mcpField
P
plain-language

plain-language

github.com/dobroslavradosavljevicAgent 工作流352 次安装3 天前更新
代码仓库

关于 plain-language

plain-language 是一项面向 Agent 的技能,要求 Agent 按 ASD-STE100 简明技术英语规范撰写文本并命名代码。它通过句长、用词、语态和命名规则,帮助保持面向用户的内容清晰一致。

主要功能

  1. 01ASD-STE100 写作检查
  2. 02句子与段落长度限制
  3. 03统一用词规则
  4. 04清晰命名指南
  5. 05技术术语与引文规则

适用场景

  1. 01发送前检查 Agent 回复
  2. 02撰写简洁的技术说明
  3. 03为文件和符号选择清晰名称

安装

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

$npx skills add https://github.com/dobroslavradosavljevic/skills --skill plain-language

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

包含的文件

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

agents/
openai.yaml
references/
examples.md
explanations.md
naming.md
ste.md

详细介绍

通俗语言

面向用户的所有 Agent 文本都必须遵守的严格写作标准。也适用于代码库中的名称。

只有通过以下 STE 检查后,才能发送回复。必须遵守此标准。不要为了“语气”“润色”或“显得专业”而放宽要求。

严格标准(ASD-STE100)

ASD-STE100 简化技术英语是一种受控写作标准,由航空航天和国防领域的团体制定。它能帮助人们写出清晰的技术文本。

关键规则:

  • 只使用认可的词语。 该标准提供词表,每个词只有一种含义。
  • 一个概念只用一个词表达。 同一事物不要使用不同词语。
  • 句子要简短。 指令不超过 20 个词。
  • 使用主动语态。 写“Turn the switch”,不要写“The switch must be turned”。
  • 段落要简短。 每段只写一个主题。

目标: 让文本易于阅读。许多读者的母语不是英语。清晰的文本能帮助他们安全、正确地完成工作。此回答遵循这些规则。

完整的写作检查:ste.md。

如何在此应用 STE

此技能不包含官方 STE 词典。请将简单常见的英语视为词表。

  1. 优先使用简短、常见的词(use、start、stop、show、set、get、fix、add、remove)。
  2. 回复中的每个词只表达一种含义。同一事物不要切换使用同义词(login / sign-in / auth)。
  3. 保留必要的产品名称和 API 名称。首次出现难懂术语时,用一个简短句子解释。之后重复使用同一术语。
  4. 引文、错误文本、代码和文件路径保持原样。用符合 STE 的文字包围它们。
  5. 如果用户已为某事物命名,就沿用用户使用的词语。不要在正文中改名。

句子和段落限制(必须遵守)

句子类型限制
指令 / 命令 / 后续步骤不超过 20 个词
描述 / 状态 / 原因不超过 25 个词
段落一个主题。最好包含 1–3 个简短句子。

拆分冗长的想法。不要用“and/which/that”串联从句。

语态(必须遵守)

  • 使用主动语态,并明确主语。
  • 用祈使句告诉用户要做什么:Run the tests.,不要写 The tests should be run.
  • 用现在时描述当前事实。用过去时描述已发生的事情。
  • 不要使用填充词:leverage、utilize、facilitate、robust、seamless、holistic、in order to、it is important to note。

核心要求

  1. 开头先说明结果、下一步操作或含义。使用日常用语。
  2. 只有在日常用语会导致错误修改时,才使用精确的技术词。首次使用时解释一次。
  3. 名称应清楚表达英文含义。不要使用谜语、网络梗或晦涩的缩写组合。
  4. 每个句子只表达一个想法。每段只讨论一个主题。

何时保留技术术语

出现以下情况时,保留原名称:

  • 用户要求使用准确的 API、类型、SQL 或标志名称。
  • 换成日常用语会导致错误操作(merge 与 rebase 的区别)。
  • 必须引用真实的符号、错误或配置键,才能让用户采取行动。

然后:

  1. 先给出 STE 摘要(1–2 个简短句子)。
  2. 接着给出准确术语,并解释一次。
  3. 只有在必要时,最后给出原始错误文本或类型定义。

除非用户正在深入排查问题且先使用了这些术语,否则不要在状态更新、选项列表或“已更改内容”中使用行话。即使如此,也要遵守 STE 的句子限制。

工作流程(每次回复都要执行)

  1. 列出事实。
  2. 按 STE 改写草稿。删减文字。拆分句子。改用主动语态。
  3. 检查同义词。每个概念选用一个词,并始终使用该词。
  4. 检查准备提出的名称。展示前,重命名晦涩或刻意耍巧的标识符。
  5. 统计指令句数。如果某个指令句超过 20 个词,就拆分它。
  6. 完成检查后再发送。

用户说 plain-language、STE、“say it simply”或“rename this clearly”时,也要审查指定文件,并改写或重命名其中的内容。

命名

在创建或重命名文件、文件夹、符号、路由、标志或领域术语时应用。

目标推荐避免
文件 / 文件夹user-profile-form.tsx、billing/UPF.tsx、mgr/、tmp2-final-FINAL/
函数getUserById、saveInvoicehandleStuff、doIt、proc、run
布尔值isOpen、hasAccess、canEditflag、check、val
类型Invoice、UserSessionIData、Thing、ManagerManager

名称检查:

  1. 大声读出来。 它能说明自己的用途吗?
  2. 搜索检查。 你会搜索这个词来查找该功能吗?
  3. 队友检查。 新队友能从名称猜出对应文件夹吗?
  4. 玩笑检查。 如果名称有趣却含义不清,就重命名。

详情:naming.md。说明模式:explanations.md。前后对比:examples.md。

反模式(绝不采用)

  • 被动描述状态:“迁移已成功执行。”
  • 冗长的堆叠名词:“客户账单对账流水线编排器”
  • 在同一条回复中用两个名称指代同一事物
  • 学术或营销口吻
  • 字母汤式文件名(usrCtlrV2.ts)
  • 只贴出堆栈跟踪,不加简短的 STE 引导语

评论

支持 Markdown