skills.rest
superplanehq
superplanehqOFFICIAL
Explore all skills by this author →
Website𝕏@superplanehqGitHub

simplified-technical-english

Write technical text following ASD-STE100 Simplified Technical English grammar and style rules.

5.7k|625|Updated May 7, 2025
Search Tags:#style guide#Technical Writing#Documentation#pr descriptions#ui copy#asd-ste100#simplified technical english
One-click install
npx skills add https://github.com/superplanehq/superplane --skill simplified-technical-english
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: simplified-technical-english
Source: https://github.com/superplanehq/superplane/tree/main/.agents/skills/simplified-technical-english
Command: npx skills add https://github.com/superplanehq/superplane --skill simplified-technical-english

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Technical writing for PRs, UI copy, docs, and error messages often uses inconsistent vocabulary, long sentences, and idioms that confuse non-native readers and reviewers. This Skill enforces ASD-STE100 Simplified Technical English writing rules so all user-facing and reviewer-facing text stays clear, unambiguous, and consistent.

Core Features & Use Cases

  • STE grammar and style rules: Enforces active voice, imperative commands, sentence length limits (20 words for instructions, 25 for descriptions), and one-term-per-concept vocabulary.
  • SuperPlane technical nouns: Provides an approved vocabulary list (canvas, organization, integration, trigger, run, approval) so product terms stay consistent across surfaces.
  • Scope exceptions: Preserves Conventional Commits prefixes, code identifiers, API paths, proper nouns, and issue IDs without rewriting them.
  • Use Case: When drafting a PR description and test plan, the Skill rewrites vague steps like "make sure everything works" into concrete checklist items such as "Connect GitHub from the onboarding screen" and "Confirm the status shows Connected."

Quick Start

Rewrite this PR description and test plan using Simplified Technical English rules with short sentences and imperative test steps.

Frequently Asked Questions about simplified-technical-english

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

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

Use short descriptive sentences of at most 25 words, active voice, and one consistent term per concept. State what changed and why without narrative filler, and write test plan steps as imperative checklist items of at most 20 words each.

What is ASD-STE100 Simplified Technical English?▼

ASD-STE100 is an international standard for technical documentation that restricts grammar and approved vocabulary to remove ambiguity. This Skill applies its writing rules such as sentence limits and active voice, but does not embed the copyrighted approved-words dictionary.

Does STE rewriting apply to commit messages and code identifiers?▼

STE rules apply to commit message bodies but not to Conventional Commits type prefixes like feat: or fix:. Code identifiers, API paths, proto names, log lines, quoted error codes, and proper nouns are explicit exceptions and stay unchanged.

What are the sentence length limits in Simplified Technical English?▼

Procedures, instructions, and test steps allow a maximum of 20 words per sentence with one instruction per sentence. Descriptive text such as PR summaries and explanatory UI copy allows a maximum of 25 words per sentence.

When should I not use Simplified Technical English rules?▼

Do not apply STE rewriting to code identifiers, proper nouns, product names, issue IDs, or DCO trailers. The rules target user-facing and reviewer-facing prose, not machine-readable names or legally required trailers.

Related Skills

Explore More Content & Communication Skills→
ReadyStateChangeReadyStateChange

describing-pull-requests

Generate GitHub PR descriptions from diffs, commits, and templates.

Official
Intermediate
amanm02amanm02

copy-editing

Revise marketing copy for clarity, persuasion, and conversion readiness.

Official
Advanced
sfdc-brendansfdc-brendan
15

sf-lwc-content

Provide microcopy templates for errors, empty states, and labels in Lightning Web Components.

Community
Basic
ghalacticghalactic

google-developer-style-guide-formatting

Enforce Google developer documentation style guide formatting with Vale.

Official
Intermediate