Skip to content

Rewrite documentation per ASD-STE100 Simplified Technical English - #418

Merged
elharo merged 1 commit into
masterfrom
rewrite-docs-asd-ste100-2
Aug 4, 2026
Merged

Rewrite documentation per ASD-STE100 Simplified Technical English#418
elharo merged 1 commit into
masterfrom
rewrite-docs-asd-ste100-2

Conversation

@elharo

@elharo elharo commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

This PR rewrites the maven-shared-io and maven-shared-utils download.xml.vm and index.apt.vm documentation to comply with ASD-STE100 Simplified Technical English rules. Changes include: removing banned words (simply, strongly), removing 'it is' constructions, using only approved modals (must, can, will), splitting long sentences (max 25 words), and using simple tenses.

@elharo elharo added the documentation Improvements or additions to documentation label Aug 1, 2026
@elharo
elharo merged commit e8c61b5 into master Aug 4, 2026
15 checks passed
@elharo
elharo deleted the rewrite-docs-asd-ste100-2 branch August 4, 2026 10:52
@github-actions github-actions Bot added this to the 3.5.0 milestone Aug 4, 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