docs(docs/.style/style-guide): adopt STE-derived prose rules - #27852
Merged
Conversation
Two internal-consistency fixes in the prose style guide: - The directional-language section in accessibility-and-inclusion.md used "See the [Latin abbreviations rule]" as a Do example and recommended "see the following section" in its replacements table. Both violate the navigational-"see" ban that word-choice.md applies to all docs. Reword to "refer to". - The one-sentence-per-line Do and Don't examples in formatting.md were byte-identical single source lines, so the Don't examples showed no violation. Blockquotes re-join lines when rendered, which hid the problem. Convert the examples to fenced md blocks that show the actual source line breaks. Assisted-by: AI
Incorporate the transferable rules from ASD-STE100 Simplified Technical English (Issue 9, 2025) into the prose style guide, with per-rule attribution to the source rule numbers: - New "Procedural writing" page: one instruction per step (5.2), condition before instruction (5.4), 20-word step budget (5.1), callouts inform while steps instruct plus the delete-the-callouts test (5.5), and warnings state the consequence (7.2, 7.3). - Voice and tone: sentence and paragraph budgets (6.1-6.6), verbs over noun forms (3.7), one clear referent per pronoun (GR-3, GR-4), and an explicit acknowledgment of the contractions trade-off for international readers. - Word choice: one term per concept (1.11, 9.4), anchored on the glossary. - Accessibility and inclusion: extend the idioms rule to developer figurative verbs (spin up, tear down, stand up). - README: register the new page and add ASD-STE100 to the third-party references. The STE dictionary, part-of-speech restrictions, and tense limits are deliberately not adopted. They target readers of safety-critical maintenance manuals, not readers of developer documentation. Assisted-by: AI
bpmct
approved these changes
Aug 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stacked on #27849.
Incorporates the transferable rules from ASD-STE100 Simplified Technical English (Issue 9, 2025) into the prose style guide, with per-rule attribution to the source rule numbers. STE is the controlled-language standard for aerospace maintenance documentation; this PR adopts its procedure-level discipline and clarity rules, not its controlled dictionary or grammar restrictions, which target a different audience.
All new rules are documentation-only (no Vale rule) because they need editorial judgment rather than pattern matching.
🤖 Built with AI assistance.