simple-english

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

3|Updated Sep 18, 2025
One-click install
npx skills add https://github.com/KingMichaelPark/dotfiles --skill simple-english-kingmichaelpark
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: simple-english
Source: https://github.com/KingMichaelPark/dotfiles/tree/main/ai/.agents/skills/simple-english
Command: npx skills add https://github.com/KingMichaelPark/dotfiles --skill simple-english-kingmichaelpark

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Technical documentation is often full of long sentences, inconsistent terminology, hedging, and AI-generated filler that confuses readers—especially non-native English speakers and on-call engineers reading under pressure. This Skill rewrites or audits technical text against the 53 rules of ASD-STE100 Simplified Technical English so every sentence survives a single read. ## Core Features & Use Cases - Rule-based rewriting: Applies the full ASD-STE100 rule catalog—20/25-word sentence limits, one instruction per sentence, active voice, condition-before-command, and banned modals like "should" and "could". - Two modes: Pragmatic mode for everyday docs (READMEs, error messages) and strict mode for users who name STE or ASD-STE100 compliance. - Check mode with citations: Audits existing text and reports each violation with rule number, offending text, and a compliant rewrite, backed by a searchable verification checklist. - Use Case: Paste a confusing error message like "Oops! Something went wrong..." and get back "Connection to the database failed. Set DB_PASSWORD and connect again." ## Quick Start Rewrite this README section using Simplified Technical English rules and list every violation you fixed.

Frequently Asked Questions about simple-english

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

FAQPage Schema
How do I rewrite documentation in Simplified Technical English?

Provide your text and ask for STE rewriting. The skill classifies each passage as procedural or descriptive, applies the 53 ASD-STE100 rules, enforces sentence limits of 20 words for instructions and 25 for descriptions, and runs a self-check before delivering.

What is ASD-STE100 Simplified Technical English?

ASD-STE100 is a controlled language standard from aerospace maintenance documentation with 53 writing rules and an approved-word dictionary. It removes ambiguity so non-native English readers cannot misread instructions. The official standard is a free download at asd-ste100.org.

Can I check existing text for STE rule violations?

Yes, check mode audits your draft and reports each violation with its rule number, the offending text, and a compliant rewrite. A references checklist provides searchable patterns for contractions, banned modals, semicolons, and trailing conditions.

Does Simplified Technical English work for error messages and runbooks?

Yes, error messages and runbooks are primary targets. Error messages state what happened, the cause, and the fix as an imperative. Runbooks use one instruction per step with conditions first and warnings before dangerous steps.

When should I not use Simplified Technical English?

Do not apply STE to marketing copy, blog posts, or brand writing because it removes persuasion by design. Use it only for technical facts and instructions where misreading has a cost, such as docs, procedures, and incident reports.

Does this skill guarantee ASD-STE100 compliance?

No tool can guarantee full ASD-STE100 compliance because the official approved-word dictionary is copyrighted and not reproduced here. Strict mode applies full vocabulary discipline, but final approval rests with the writer using the official standard.