docs: adopt Simplified Technical English (ASD-STE100) for English prose - #143
Merged
Merged
Conversation
Deploying klassroom with
|
| Latest commit: |
7a09053
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://6515dd5a.klassroom-18s.pages.dev |
| Branch Preview URL: | https://docs-simplified-technical-en.klassroom-18s.pages.dev |
There was a problem hiding this comment.
Pull request overview
This PR updates AGENTS.md to add a repository-wide writing standard for English prose based on Simplified Technical English (ASD-STE100), to guide future documentation, comments, and user-visible strings.
Changes:
- Add a new “Writing style — Simplified Technical English” section describing the STE standard and where it applies.
- Add a concise rule subset (voice, tense, sentence structure, and style constraints) for practical use by contributors and agents.
- Clarify that Polish user-facing copy should follow plain Polish (prosta polszczyzna) instead.
Suppressed comments (1)
AGENTS.md:99
- Several bullet items are written in telegraphic style (for example, “Maximum …”), but the same section instructs writers not to use telegraphic style. Rewrite these bullets to use imperative sentences and include helper words.
- Active voice. Imperative mood for instructions.
- Simple tenses only. Do not use a gerund as a noun or an adjective.
- One instruction per sentence. Maximum 20 words per instruction, 25 per descriptive sentence.
- Put the condition before the action. Keep articles and helper words. Do not write in telegraphic style.
- No jargon, idiom, metaphor, or humor. Maximum 3 words per noun cluster.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
sgraczyk
force-pushed
the
docs/simplified-technical-english
branch
from
August 2, 2026 21:15
24612e8 to
7a09053
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (1)
AGENTS.md:93
- The new Writing style guidance is a single long sentence split across multiple hard-wrapped lines (and uses em dashes), which makes it harder to read and also makes the “working subset” less scannable. Consider rewriting it as a short intro sentence plus a bullet list of rules (and clarify that the scope is English user-visible strings, since Polish user-facing copy is governed by the next paragraph).
English prose — docs, code comments, commit and PR text, issues, user-visible strings —
follows [Simplified Technical English](https://www.asd-ste100.org/) (ASD-STE100): one
meaning per word, active voice, imperative for instructions, simple tenses, one
instruction per sentence (max 20 words), no jargon or metaphor. Code identifiers are exempt.
Polish user-facing copy follows *prosta polszczyzna* instead ([jasnopis.pl](https://jasnopis.pl/), ISO 24495-1).
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
One paragraph in the agent file requiring Simplified Technical English (ASD-STE100) for English prose — docs, code comments, commit and PR text, issues, user-visible strings. Code identifiers are exempt.
Kept to the rules that actually change output rather than restating all 53; the standard is linked for the rest.
Docs-only change.
🤖 Generated with Claude Code