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…

What is this?This is an Agent Skill that makes an LLM write and check text in Simplified Technical English (STE), the ASD-STE100 controlled language used by the aerospace and defense industries for manuals. It ships the SKILL.md rules, the approved word list, and a Python check tool.
Is this a Claude-only skill, or can I use it with any LLM?It is built as a Claude Skill but is portable: for other LLMs you just copy the text of SKILL.md into the system prompt, and optionally add the substitutions and word-list files for better results.
How do I install it for Claude?Clone the repository into your Claude skills folder (~/.claude/skills/), then tell Claude to write or check text in STE, or invoke it directly by typing /simplified-technical-english.
What do I need to run the check tool?Just Python 3 — the stecheck.py script has no other dependencies and runs on a file path or standard input.
Does the check tool catch every STE violation?No. It flags things like overlong sentences, passive voice, unapproved words, and contractions, but it cannot tell if a word is used with its approved meaning, so a human who knows STE still has to review important text. It's also not an official ASD document and can't guarantee full compliance with the real specification.
Who is this really for?Technical writers and teams producing aerospace/defense manuals or any documentation that needs to follow the ASD-STE100 controlled-language standard, plus anyone who wants LLM output in short, clear, easy-to-translate English.
Does it run on Windows and Linux as well as Mac?Yes — it's a Python script and a markdown-based skill, so it runs anywhere Python 3 and Claude's skill folder are available, not tied to a specific OS.
How many approved words does the word list contain?The references/word-list.md file lists 869 approved words that the skill and check tool allow.
What does the check tool actually flag?It flags sentences with too many words, paragraphs over six sentences, unapproved verb forms and passive voice, semicolons, contractions, unapproved helping verbs, and words outside the approved list, reporting each error with its rule number.
Where do the writing rules come from?They come from ASD-STE100 Issue 7 (2017), the official Simplified Technical English specification maintained by ASD; the skill reproduces 53 of its writing rules in references/writing-rules.md.
Can I see an example of the rewrite in action?Yes, examples/before-after.md shows text before and after the STE rewrite, e.g. turning 'Prior to commencing the installation, it should be ensured...' into 'Before you start the installation, examine all the components for damage.'
Creator
0xpili
Size
<0.1 MB
Stars
1K
Updated
CommitAug 16
Age
2mo
Commits · 90 Days