ste

Solid

Write and rewrite technical prose in Simplified Technical English style: short declarative sentences, active voice, imperative procedures, one term per concept, no hedges, and explicit conditions. Never simplifies code, commands, identifiers, paths, or quoted literals. Marks missing values with a placeholder rather than inventing one. Ships a deterministic checker. TRIGGER when: asked to write, rewrite, simplify, clarify, tighten, or review documentation, a README, a runbook, a spec, release notes, a PR or commit body, an error message, CLI help text, an API description, or agent instructions; or when asked for plain English, controlled language, STE, Simplified Technical English, or "make this unambiguous".

AI & Automation 38 stars 3 forks Updated today Apache-2.0

Install

View on GitHub

Quality Score: 83/100

Stars 20%
53
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# STE — Simplified Technical English Write prose that one reader resolves one way. Apply this skill to any text that lands in a git-tracked file or a GitHub-posted body. ## Status and affiliation This skill claims **no ASD-STE100 certification** and **no complete standards compliance**. STEMG publishes and maintains ASD-STE100. STEMG neither endorses nor certifies this skill. The authoritative standard lives at `https://www.asd-ste100.org/`. This skill follows the published shape of that standard: a set of writing rules plus a controlled vocabulary. Every rule statement and every word entry here carries our own wording. This skill reproduces no text from ASD-STE100 Issue 9 and no entry from its controlled dictionary. Read the standard itself when you need the standard itself. ## Priority order Apply these in order. A longer sentence wins when the longer sentence removes ambiguity. 1. **Technical correctness** — the text must state what the software does. 2. **Unambiguous meaning** — one reading, not two. 3. **Consistent terminology** — one term per concept, everywhere. 4. **Explicit sequencing** — the reader knows what comes first. 5. **Concision** — cut what carries no information. ## Never simplify these Copy each of the following byte for byte. Rewriting any of them breaks the text: - code blocks and inline code - commands, flags, and arguments - API names, function names, and symbol names - filenames, directory names, and paths - identifiers, environment-variabl...

Details

Author
mifunedev
Repository
mifunedev/openharness
Created
5 months ago
Last Updated
today
Language
TypeScript
License
Apache-2.0

Similar Skills

Semantically similar based on skill content — not just same category

Code & Development Listed

simplified-technical-english

Write clear, unambiguous English for technical documentation using Simplified Technical English principles (adapted from ASD-STE100 Issue 9). Use this skill whenever you write or review PR descriptions, commit bodies, READMEs, API documentation, ADRs, changelogs, runbooks, error messages, migration guides, code comments, or release notes — and any time the audience includes non-native English readers or machine translation. Also use it when the user asks for "STE", "ASD-STE100", "simplified English", "plain technical English", or asks to make documentation clearer, shorter, or easier to translate.

7 Updated 3 weeks ago
DotDebian
AI & Automation Listed

simplified-technical-english

Enforce ASD-STE100 Simplified Technical English (STE) in all technical documentation you write or edit. Use this skill whenever you draft, generate, or revise READMEs, specifications, design docs, architecture decision records (ADRs), runbooks, technical playbooks, API docs, configuration and setup guides, troubleshooting guides, release notes, inline code comments, or docstrings — any project documentation that describes technical aspects of a system. Apply it even when the user does not mention "STE", "controlled language", or "plain English". It keeps documentation short, active, and consistent so a global audience with basic English can read it correctly the first time. Do not apply it to marketing copy, casual chat replies, or narrative prose where a natural voice is wanted.

0 Updated 1 weeks ago
ebellefontaine
Data & Documents Listed

simplified-technical-english

Writes and rewrites text in Simplified Technical English (ASD-STE100), a controlled language for clear technical documentation. Use when the user asks for STE, Simplified Technical English, controlled language, or plain technical writing, and when the user asks to write, rewrite, review, or check technical documentation, procedures, manuals, instructions, warnings, or reports.

2 Updated 3 weeks ago
0xpili