Technical Writing
Standards define principles or controlled-language rules for clear writing. Company style guides provide editorial conventions and terminology for consistent documentation and UI text.
Standards and Controlled Language
- ASD Simplified Technical English (STE) - Controlled English with writing rules and a dictionary, originally developed for aircraft maintenance documentation. Use it for procedural instructions where consistent wording reduces ambiguity. Request a free copy, or read the background on Simplified Technical English.
- ISO 24495-1:2023 Plain language - Part 1: Governing principles and guidelines - Plain-language principles applicable across written languages. Use them to make policies, instructions, and user-facing information easier to find, understand, and use. The abstract and sample are public; the full standard is paid.
Company Style Guides
- Google Developer Documentation Style Guide - Editorial guidance for developer documentation. Use it when writing API references, tutorials, and code explanations.
- Microsoft Writing Style Guide - Organizational style and terminology guidance for documentation and UI text. Use it to keep product instructions and interface wording consistent. The online guide replaces the Microsoft Manual of Style; see the Manual of Style history and background.
- Apple Style Guide - Editorial and terminology guidance for documentation, training materials, and UI text. Use it when writing about Apple products or aligning instructions with Apple interface terminology.
Comparing Standards and Style Guides
| Aspect | STE (ASD-STE100) | Microsoft | Apple | ISO 24495-1:2023 | |
|---|---|---|---|---|---|
| Type | International controlled-English specification | Developer documentation style guide | Technology writing style guide | Editorial style guide | International plain-language standard |
| Primary scope | Technical documentation; originated in aircraft maintenance | Developer documentation | Technology docs, UI, web content, and white papers | Instructional, reference, training, and UI content | Written languages, including technical writing and controlled languages |
| Vocabulary | Controlled general dictionary plus permitted technical names and verbs | Developer terminology recommendations | Terminology and word-choice guidance | Consistent wording and Apple terminology | Reader-focused, understandable, usable wording |
| Sentence guidance | Explicit sentence-length rules | Short sentences | Concise sentences | Clear, direct sentences | Reader-focused sentence structure |
| Voice/style | Active voice required in procedures; passive permitted in descriptive writing | Conversational; addresses readers as 'you' | Warm, conversational, concise | Consistent editorial style | Reader-focused clarity and usability |
| Access | Free by request; copyright retained | Public online | Public online | Public online | Public abstract and sample; full text paid |
STE checkers are aids, not proof of compliance: they can make mistakes and cannot check every rule. ASD does not certify checkers. See ASD's software guidance and FAQ.
Choosing a Guide
Follow project conventions first, then choose one style guide as your baseline for decisions they do not cover. For developer documentation, Google is a practical starting point; use Microsoft or Apple when their terminology fits the product. Apply ISO plain-language principles during review, and use STE when the work requires controlled procedural language.