Skip to content

docs: adopt Simplified Technical English (ASD-STE100) for English prose - #143

Merged
sgraczyk merged 1 commit into
mainfrom
docs/simplified-technical-english
Aug 2, 2026
Merged

sgraczyk merged 1 commit into
mainfrom
docs/simplified-technical-english

Conversation

@sgraczyk

@sgraczyk sgraczyk commented Aug 2, 2026

Copy link
Copy Markdown
Contributor

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

Copilot AI review requested due to automatic review settings August 2, 2026 21:12
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Aug 2, 2026

Copy link
Copy Markdown

Deploying klassroom with  Cloudflare Pages  Cloudflare Pages

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

View logs

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread AGENTS.md Outdated
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings August 2, 2026 21:15
@sgraczyk
sgraczyk force-pushed the docs/simplified-technical-english branch from 24612e8 to 7a09053 Compare August 2, 2026 21:15

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

@sgraczyk
sgraczyk merged commit 56e916d into main Aug 2, 2026
6 checks passed
@sgraczyk
sgraczyk deleted the docs/simplified-technical-english branch August 2, 2026 21:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants