Skip to content

Website: add technical writing review checklist - #384

Open
heylaurens wants to merge 2 commits into
canonical:mainfrom
heylaurens:docs/technical-writing-review-checklist-2026
Open

Website: add technical writing review checklist#384
heylaurens wants to merge 2 commits into
canonical:mainfrom
heylaurens:docs/technical-writing-review-checklist-2026

Conversation

@heylaurens

Copy link
Copy Markdown

Closes #353.

Summary

  • add a technical writing review checklist to the website reference section
  • cover purpose, completeness, accuracy, structure, clarity, consistency, accessibility, media, and maintainability
  • add the new page to the reference navigation
  • link to the Canonical documentation style guide and Diataxis reference guidance

Checks

  • make html: passed with warnings treated as errors
  • make spellcheck: passed with the en_GB dictionary
  • both links added by this change return HTTP 200
  • git diff --check origin/main...HEAD: passed
  • Gitleaks v8.30.1 over origin/main..HEAD: no leaks found

make linkcheck reaches both links added by this change, but the complete local run exits non-zero on an existing link outside this diff: https://www.gnutls.org/ in docs/explanation/glossary_what.md:74 returns a TLS hostname mismatch. The latest main documentation workflow is green.

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.

Website: Checklist for technical writing

1 participant