Skip to content

docs: rewrite documentation in Simplified Technical English (ASD-STE100) - #323

Draft
lc-kirill wants to merge 1 commit into
masterfrom
docs/simplified-technical-english
Draft

docs: rewrite documentation in Simplified Technical English (ASD-STE100)#323
lc-kirill wants to merge 1 commit into
masterfrom
docs/simplified-technical-english

Conversation

@lc-kirill

Copy link
Copy Markdown

Rewrites 350 of the 357 in-scope pages under docs/ into ASD-STE100 Simplified Technical English.

This is a language-only change. No fact, permission, version, limit, default, or platform claim was added, removed, or altered. Where a page said something wrong, it still says it — those cases are listed as follow-ups rather than silently fixed.

What changed in the prose

  • Active voice with a named actor, replacing agentless passives.
  • Sentences capped at 25 words (20 for an instruction), one instruction per sentence.
  • Prose procedures converted to numbered lists of imperative steps, with continuation content indented so lists stop fragmenting and restarting at "1.".
  • Simple tenses only; gerund subjects rewritten as clauses.
  • Articles restored; noun clusters over three words broken up.
  • Warnings and cautions now lead with the command, then the reason.
  • Approved-word substitutions: utilizeuse, viawith/through, ensuremake sure, prior tobefore, followobey, and similar.
  • Marketing vocabulary and idiom removed — "for the modern era", "best-of-breed", "seamlessly", "out of the box", "spin up", "heavy lifting".
  • One term per concept, per the terminology table in the new style guide.

What is deliberately frozen

Verified mechanically byte-identical against master for all 350 files:

  • Every heading. 527 anchor links target them and mkdocs.yml mirrors them as nav labels, so rewording headings would break links across the site for very little gain. This is the main scope limit of the PR.
  • Every fenced code block, inline code span, link and image target, snippet include (--8<--), abbreviation definition, admonition/tab marker, and table shape.

Not rewritten

Seven link-index stubs of 19–89 words that were already compliant (2-sensors-deployment/index.md, 8-reference/faq/index.md, and five similar), plus three generated files: includes/glossary.md, 10-release-notes/index.md, assets/images/README.md.

Verification

Check Result
mkdocs build --strict exit 0
markdownlint-cli2 0 issues (matches the clean pre-change baseline)
scripts/check-list-numbering.py 0 new breaks
Structural diff vs master (headings, code, links, tables) 350/350 identical

Nine lint regressions appeared mid-work and are fixed in this branch: ordered-list renumbering in endpoint-agent/windows/custom-msi.md, and emphasis-as-heading in lookup-manager.md / yara-manager.md.

Two things reviewers should know

1. scripts/list-numbering-baseline.json is regenerated. The same five pre-existing numbering breaks remain — none are new. Two of them had their surrounding prose reworded, so the old baseline keys (which embed a text prefix) no longer matched and CI would have reported them as new.

2. A pre-existing rendering bug is left in place. In 2-sensors-deployment/endpoint-agent/windows/installation.md, a PowerShell block is closed with ```python instead of ```. A closing fence may not carry an info string, so the fence never closes and the whole "LimaCharlie Web Application", "Troubleshooting", and "Uninstallation" content currently renders inside a code block. The Uninstallation section repeats the pattern. I rewrote that prose but left the markup alone, because fixing it changes rendering structure rather than language. It is the one file the structural check still flags, and it deserves its own PR.

Follow-ups found but not actioned

The rewrite surfaced roughly 150 pre-existing defects — invalid JSON/YAML in samples, orphaned admonitions that lost their !!! markers, contradictory platform and response-event columns in 8-reference/endpoint-commands.md, SDK import paths that do not match the public python-limacharlie package, and several detection and response () empty-parenthesis artifacts. The full triaged list is held outside this public repo at ~/ste-rewrite-findings.md, because one entry concerns internal infrastructure identifiers that appear in a currently-published page and should not be restated here. Ask me for that item directly.

simplified-technical-english.md is added at the repo root, alongside the existing markdown-lint.md contributor doc, so the standard applied here is reviewable and repeatable. Drop it if you would rather not carry it.

🤖 Generated with Claude Code

Rewrites 350 of the 357 in-scope pages under docs/ into ASD-STE100 Simplified
Technical English. The change is language-only: no fact, permission, version,
limit, default, or platform claim was added, removed, or altered.

What changed in the prose:

- Active voice with a named actor, replacing agentless passives.
- Sentences capped at 25 words (20 for an instruction), one instruction each.
- Prose procedures converted to numbered lists of imperative steps, with
  continuation content indented so lists no longer fragment and restart at 1.
- Simple tenses only; gerund subjects rewritten as clauses.
- Articles restored; noun clusters over three words broken up.
- Warnings and cautions lead with the command, then the reason.
- Approved-word substitutions (utilize -> use, via -> with/through,
  ensure -> make sure, prior to -> before, follow -> obey, and similar).
- Marketing vocabulary and idiom removed ("for the modern era",
  "best-of-breed", "seamlessly", "out of the box", "spin up", "heavy lifting").
- One term per concept per the terminology table in the new style guide.

Deliberately frozen, and mechanically verified byte-identical:

- Every heading. 527 anchor links target them and mkdocs.yml mirrors them as
  nav labels, so rewording headings would break links for little gain.
- Every fenced code block, inline code span, link and image target, snippet
  include, abbreviation definition, admonition/tab marker, and table shape.

Not rewritten: seven link-index stubs of 19-89 words that were already
compliant, plus three generated files (includes/glossary.md,
10-release-notes/index.md, assets/images/README.md).

scripts/list-numbering-baseline.json is regenerated. The same five
pre-existing numbering breaks remain; two had their surrounding text reworded,
so the baseline keys no longer matched.

simplified-technical-english.md documents the rules applied, so the standard is
reviewable and repeatable.

Verified: mkdocs build --strict exits 0; markdownlint-cli2 reports 0 issues;
check-list-numbering.py reports 0 new breaks.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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