simplified-technical-english

简明技术英语

以 ASD-STE100 Issue 9 作为主要的受控语言来源。优先遵循项目术语和技术准确性，再考虑一般语言偏好。

工作流程

1. 确定读者、任务和所需结果。
2. 将文本归类为步骤说明、描述、注释或安全说明。
3. 确定已批准的项目术语、标识符和必需措辞。
4. 每个概念使用一个术语。
5. 撰写最简洁且完整的陈述。
6. 应用本文件中的适用规则。
7. 如需准确映射规则或进行详细审查，请加载写作规则参考。
8. 当词汇细节至关重要时，请加载词典参考。
9. 审查每个修改过的句子。

完成后，文本应：

• 保留技术含义。
• 始终如一地使用项目术语。
• 不含尚未消除的歧义。
• 包含每项必要的条件、操作、结果和风险。

核心写作规则

• 使用常见、具体的词语。
• 技术术语正确时，使用项目术语。
• 仅以已批准的含义和词形使用已批准的词语。
• 除非项目要求使用其他形式，否则使用美式英语。
• 使用主动语态。
• 仅在施事者未知时使用被动语态。
• 每项操作都使用清晰的动词。
• 不要用名词短语替代清晰的动词。
• 不要将技术名词用作动词。
• 不要将技术动词用作名词。
• 多词名词最多包含三个词。
• 使用清晰的短形式之前，先引入必要的长术语。
• 不要省略必要的词语。
• 不要使用缩写形式。
• 不要使用未批准的短语动词。
• 不要使用分号。
• 使用列表，让复杂文本更易于阅读。
• 对同一对象或操作使用相同的术语和句式。

步骤说明

• 每个句子最多使用 20 个词。
• 每个句子只写一条指令。
• 只有在操作同时发生时，才合并指令。
• 每条指令都以祈使动词开头。
• 将条件放在依赖该条件的命令之前。
• 用逗号分隔条件。
• 将每项前提置于依赖它的操作之前。
• 结果很重要时，说明预期结果。

描述和注释

• 每个句子最多使用 25 个词。
• 逐步提供信息。
• 每个句子只包含一个主语。
• 每个段落只讨论一个主题。
• 每个段落最多包含六个句子。
• 重复关键术语有助于明确关联时，重复使用这些术语。
• 不要在注释中写入指令、要求、限制或安全信息。

安全说明

• 使用项目的风险标签。
• 有受伤或死亡风险时，使用警告。
• 有损坏风险时，使用注意。
• 以清晰的命令或条件开头。
• 说明风险或可能的结果。
• 保留安全措辞、测量值、限制、标识符和零件编号。

代码注释和软件文本

• 说明代码存在的原因。
• 说明代码所保留的规则或不明显的约束。
• 不要重复陈述代码内容。
• 对于变通方案，说明需要采用该方案的条件。
• 已知时，注明相关问题或移除条件。
• 对于错误消息，指出失败的操作或无效值。
• 用户可以纠正问题时，说明纠正操作。
• 当消息不是完整句子时，保留仓库格式。

情态动词

• 用 must 表示义务。
• 用 can 表示可能性、能力或许可。
• 不要在 STE 文本中将 may 用作动词。
• 普通祈使指令前不要添加 must。

最终审查

请提出以下问题：

• 读者能否识别执行者、动作和对象？
• 读者能否区分信息和指令？
• 每个条件是否都在依赖它的动作之前出现？
• 每个项目术语是否只有一种含义和一种拼写？
• 代词是否可能指代多个名词？
• 每个程序步骤句子是否不超过 20 个单词？
• 每个描述或注释句子是否不超过 25 个单词？
• 读者是否可能对一个句子作出两种不同的理解？

改写每个未通过检查的句子。

来源核验

请勿将完整源 PDF 加载或提取到上下文窗口中。

1. 从官方 Issue 9 请求页面获取 Issue 9。
2. 将 PDF 保存为 assets/ASD-STE100-ISSUE-9.pdf。
3. 将 ASD_STE100_PDF 设置为保存的 PDF 路径。
4. 日常写作和审查时使用此文件。
5. 需要精确核查来源时，运行有界搜索脚本。
6. 只阅读返回的摘录和引用的页面。
7. 对于一个问题，提取的 PDF 页面不得超过连续 3 页。
8. 进行完整审计时，分开处理不同的规则组。

在技能文件夹中运行以下命令：

uv run scripts/search_issue_9.py "Rule 5.3"
uv run scripts/search_issue_9.py --word "may"
uv run scripts/search_issue_9.py --pdf ./assets/ASD-STE100-ISSUE-9.pdf "Rule 5.3"

未经完整审查，请勿声称完全符合 ASD-STE100。

请勿声称获得认证或 ASD 背书。