simplified-technical-english README

The project's README from github.com/0xpili/simplified-technical-english. As one markdown file: README.md.

Simplified Technical English skill

This skill makes an LLM write in Simplified Technical English (STE). STE is a controlled language for technical documentation. The specification ASD-STE100 gives the rules of STE and its dictionary. The aerospace and defense industries use STE for their manuals. Text in STE is clear, short, and easy to translate.

The skill obeys the rules that it gives. This README is in STE.

Example

Text before the change:

Prior to commencing the installation, it should be ensured that all components have been thoroughly inspected for damage.

Text after the change:

Before you start the installation, examine all the components for damage.

Contents of this repository

File Function
SKILL.md The primary instructions for the LLM
references/writing-rules.md The 53 writing rules, with examples
references/word-list.md The 869 approved words
references/substitutions.md Replacements for frequent unapproved words
examples/before-after.md Examples of text before and after the change
scripts/ste_check.py A check tool for the STE rules
NOTICE.md Copyright information

How to install the skill for Claude

  1. Clone this repository into your skills folder:

    git clone https://github.com/0xpili/simplified-technical-english.git ~/.claude/skills/simplified-technical-english
    
  2. Tell Claude to write or examine technical text in STE.

  3. Claude finds the skill and obeys the rules.

You can also start the skill directly. Type /simplified-technical-english.

How to use the skill with a different LLM

  1. Open SKILL.md. Copy its text into the system prompt of the LLM.
  2. If the LLM accepts more text, add the text of references/substitutions.md.
  3. For the best results, also add the text of references/word-list.md.
  4. Tell the LLM to write technical text.

How to do a check of a text

Run the check tool on a file or on standard input:

python3 scripts/ste_check.py --mode procedural draft.txt
python3 scripts/ste_check.py --mode descriptive chapter.md

The tool finds these errors:

The tool uses only Python 3. The tool shows each error and its rule number.

Limits of the skill

The tool cannot find all the errors. The tool cannot know if a word has its approved meaning. A person who knows STE must also examine an important text. This skill is not an official ASD document. This skill cannot make sure that your text obeys the official specification fully.

The source of this skill is ASD-STE100 Issue 7 (2017). ASD releases new issues of the specification. You can get the specification free of charge from https://www.asd-ste100.org. The dictionary of ASD-STE100 is the property of ASD. Refer to NOTICE.md. The text of this skill and its scripts have the MIT license. Refer to LICENSE.

simplified-technical-english (0xpili/simplified-technical-english)

Searching Database…

这是什么?这是一个 Agent Skill,让 LLM 用简明技术英语(STE)写作和检查文本——STE 即 ASD-STE100,是航空航天和国防行业用于手册的受控语言。它包含 SKILL.md 规则、核准词表和一个 Python 检查工具。
这是 Claude 专属技能,还是任何 LLM 都能用?它按 Claude Skill 的方式构建,但可移植:对于其他 LLM,只需把 SKILL.md 的文本复制进系统提示词,并可选地加上替换词表和词表文件以获得更好的效果。
怎么为 Claude 安装它?把仓库克隆到你的 Claude 技能文件夹(~/.claude/skills/),然后让 Claude 用 STE 写作或检查文本,或者直接输入 /simplified-technical-english 调用它。
运行检查工具需要什么?只需要 Python 3——stecheck.py 脚本没有其他依赖,可以接受文件路径或标准输入运行。
检查工具能抓住所有 STE 违规吗?不能。它会标记超长句子、被动语态、未核准词汇和缩写形式等问题,但无法判断一个词是否按核准的含义使用,所以懂 STE 的人仍需审查重要文本。它也不是官方 ASD 文档,不能保证完全符合真正的规范。
它真正面向哪些人?面向编写航空航天/国防手册或任何需要遵循 ASD-STE100 受控语言标准的文档的技术作者和团队,也面向任何想让 LLM 输出简短、清晰、易于翻译的英语的人。
它在 Windows 和 Linux 上也能像 Mac 一样运行吗?能——它是一个 Python 脚本和基于 markdown 的技能,只要有 Python 3 和 Claude 的技能文件夹就能运行,不绑定特定操作系统。
词表里有多少个核准词?references/word-list.md 文件列出了技能和检查工具所允许的 869 个核准词。
检查工具到底会标记什么?它会标记单词过多的句子、超过六个句子的段落、未核准的动词形式和被动语态、分号、缩写形式、未核准的助动词,以及核准词表之外的词,并附带规则编号报告每个错误。
这些写作规则来自哪里?它们来自 ASD-STE100 第 7 版(2017 年),即由 ASD 维护的官方简明技术英语规范;该技能在 references/writing-rules.md 中复现了其中 53 条写作规则。
能看一个改写的实际例子吗?可以,examples/before-after.md 展示了 STE 改写前后的文本,例如把 'Prior to commencing the installation, it should be ensured...' 改成 'Before you start the installation, examine all the components for damage.'
Creator
0xpili
Size
<0.1 MB
Stars
995
Updated
CommitAug 16
Age
2mo
Commits · 90 Days