doc-style-lint

Read the document once as the target audience, run configured automated checkers like Vale or markdownlint, then apply style rules section by section. Verify active voice, present tense, sentence case headings, and tested code examples before finishing.

Alex.js detects exclusionary terms such as master/slave, whitelist/blacklist, and gendered language in Markdown files. Combine it with Vale for style rules and markdownlint for formatting, then apply manual replacements like primary/replica or allowlist/denylist.

Yes, the workflow expects repository-configured checkers such as Vale, Alex.js, and markdownlint to run before the human review pass. If a tool is missing, the review reports it as absent rather than installing it.

Common mistakes include passive voice, future tense, minimizing words like just or simply, em dashes, vague link text like click here, and untested code snippets. Headings should use sentence case and paragraphs should stay under five sentences.

Style review should never override technical accuracy or rewrite the author's voice entirely. Fix clarity and inclusivity issues, but preserve correct technical content and refine phrasing rather than replacing it wholesale.