Skip to content

Rewrite site documentation in Simplified Technical English - #376

Merged
elharo merged 4 commits into
masterfrom
docs/ste100-site-rewrite
Aug 5, 2026
Merged

Rewrite site documentation in Simplified Technical English#376
elharo merged 4 commits into
masterfrom
docs/ste100-site-rewrite

Conversation

@elharo

@elharo elharo commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Summary

Rewrites the prose in src/site documentation according to ASD-STE100 Simplified Technical English.

Changes

  • Descriptive text uses simple present tense, max 25 words per sentence.
  • Procedural steps use the imperative mood, max 20 words per sentence.
  • Conditions come before commands ("If ...", then the command).
  • Removed contractions, "-ing" verb forms, semicolons, and the modals should/would/may/might/could.
  • Removed filler words (simply, please, in order to, etc.).
  • Consistent word choice (e.g. "verify").

Untouched

Code blocks, identifiers, CLI commands, file paths, product names, the Ant-to-Maven expression mapping table, and license headers are unchanged.

Files: 11 (8 APT pages, FAQ, download page, examples).

No functionality changes; documentation only.

@elharo
elharo marked this pull request as draft August 3, 2026 18:54
@elharo
elharo marked this pull request as ready for review August 4, 2026 13:29
@elharo elharo added the documentation Improvements or additions to documentation label Aug 4, 2026
@elharo
elharo requested a review from gnodet August 4, 2026 13:29
@elharo
elharo merged commit 5fcfb40 into master Aug 5, 2026
21 checks passed
@elharo
elharo deleted the docs/ste100-site-rewrite branch August 5, 2026 18:27
@github-actions github-actions Bot added this to the 3.2.1 milestone Aug 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants