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 писать и проверять тексты на Simplified Technical English (STE) — контролируемом языке ASD-STE100, используемом аэрокосмической и оборонной отраслями для руководств. В комплекте правила в SKILL.md, список одобренных слов и Python-инструмент проверки.
Это skill только для Claude или можно использовать с любым LLM?Он сделан как Claude Skill, но переносим: для других LLM достаточно скопировать текст SKILL.md в системный промпт и по желанию добавить файлы замен и списка слов для лучшего результата.
Как установить его для Claude?Склонируйте репозиторий в папку skills для Claude (~/.claude/skills/), затем попросите Claude писать или проверять текст на STE или вызовите его напрямую, набрав /simplified-technical-english.
Что нужно для запуска инструмента проверки?Только Python 3 — скрипт stecheck.py не имеет других зависимостей и работает с путём к файлу или стандартным вводом.
Ловит ли инструмент проверки каждое нарушение STE?Нет. Он помечает такие вещи, как слишком длинные предложения, пассивный залог, неодобренные слова и сокращения, но не может определить, употреблено ли слово в одобренном значении, поэтому важные тексты всё равно должен вычитывать человек, знающий STE. Это также не официальный документ ASD и не может гарантировать полное соответствие настоящей спецификации.
Для кого это на самом деле?Для технических писателей и команд, выпускающих аэрокосмические/оборонные руководства или любую документацию, которая должна соответствовать стандарту контролируемого языка ASD-STE100, а также для всех, кто хочет получать от LLM короткий, ясный и легко переводимый английский.
Работает ли он на Windows и Linux, как и на Mac?Да — это Python-скрипт и skill на основе markdown, так что работает везде, где доступны Python 3 и папка skills Claude, без привязки к конкретной ОС.
Сколько одобренных слов в списке слов?Файл references/word-list.md содержит 869 одобренных слов, которые разрешают skill и инструмент проверки.
Что именно помечает инструмент проверки?Он помечает предложения с избытком слов, абзацы длиннее шести предложений, неодобренные формы глаголов и пассивный залог, точки с запятой, сокращения, неодобренные вспомогательные глаголы и слова вне одобренного списка, сообщая каждую ошибку с номером правила.
Откуда взяты правила письма?Они взяты из ASD-STE100 Issue 7 (2017) — официальной спецификации Simplified Technical English, которую поддерживает ASD; skill воспроизводит 53 её правила письма в references/writing-rules.md.
Можно ли увидеть пример переписывания в действии?Да, 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
1K
Updated
CommitAug 16
Age
2mo
Commits · 90 Days