simple-english

Rewrite technical documentation using ASD-STE100 Simplified Technical English rules.

Updated Nov 10, 2013
One-click install
npx skills add https://github.com/bnferguson/dotfiles --skill simple-english-bnferguson
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: simple-english
Source: https://github.com/bnferguson/dotfiles/tree/main/.agents/skills/simple-english
Command: npx skills add https://github.com/bnferguson/dotfiles --skill simple-english-bnferguson

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Technical documentation is often ambiguous, verbose, and full of AI-generated filler, making it hard for non-native readers and tired operators to follow. This Skill applies the 53 rules of ASD-STE100 Simplified Technical English to produce clear, unambiguous text that survives a single read. ## Core Features & Use Cases - Rule-based rewriting: Enforces 20/25-word sentence limits, one instruction per sentence, active voice, simple tenses, and condition-before-command structure across nine rule sections. - Two modes: Pragmatic mode for everyday docs and READMEs; strict mode for full STE vocabulary discipline when compliance is requested. - Check mode: Audits existing text and reports each violation with rule number, offending text, and a compliant rewrite. - Use Case: Rewrite a confusing runbook or error message so an on-call engineer at 2 a.m. can follow it: "Connection to the database failed. Set DB_PASSWORD and connect again." ## Quick Start Rewrite this README section using Simplified Technical English rules and flag every violation you fix.

Frequently Asked Questions about simple-english

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write documentation in Simplified Technical English?▼

Classify each passage as procedural or descriptive, then apply the STE rules: 20-word limit for instructions, 25 for descriptions, imperative verbs for procedures, and conditions before commands. Pick one term per concept and keep it consistent throughout the document.

What is ASD-STE100 and when should I use it?▼

ASD-STE100 is a controlled language standard from aerospace maintenance documentation with 53 writing rules and an approved-word dictionary. Use it for runbooks, procedures, error messages, and any text where misreading has a cost, especially for non-native readers.

What is the difference between pragmatic and strict STE mode?▼

Pragmatic mode applies all structural rules while keeping domain vocabulary like "webhook" or "idempotent". Strict mode adds full vocabulary discipline using only dictionary-approved words, and full compliance requires the official dictionary from asd-ste100.org.

Can STE rules be applied to error messages and incident reports?▼

Yes. Error messages state what happened in simple past, the cause if known, then the fix as an imperative. Incident reports use simple past only, replacing hedges like "may have impacted" with concrete facts and timestamps.

When should I not use Simplified Technical English?▼

Do not apply STE to marketing copy, blog posts, or brand writing, since it removes persuasion by design. It is built for technical facts and instructions, not voice-driven content.