Skip to content

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

Open
elharo wants to merge 5 commits into
masterfrom
rewrite-docs-asd-ste100-3
Open

Rewrite documentation per ASD-STE100 Simplified Technical English#264
elharo wants to merge 5 commits into
masterfrom
rewrite-docs-asd-ste100-3

Conversation

@elharo

@elharo elharo commented Aug 2, 2026

Copy link
Copy Markdown
Contributor

This PR rewrites the maven-remote-resources-plugin download.xml.vm, index.apt.vm and faq.fml 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 marked this pull request as ready for review August 3, 2026 11:56
@elharo
elharo requested a review from michael-o August 3, 2026 11:57
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.

1 participant