Beyond spell checking - what else can we check automatically?
summary
Argues for linting docs beyond spelling with concrete checks: acronym-first-use enforcement, registered‑mark checking that flags missing ® on first mentions, alt‑text enforcement for images, heading capitalization rules and inconsistent US/UK spelling detection. Describes tools and workflow: using Veil with a GitHub Action, running checks via make targets and CI, adding custom YAML rules and PRs. Reports it works in practice: fast, configurable, growing rule set and successful pull‑request gating. alt‑text enforcement
AI-written summary · about
chapters (9)
- 0:00Introduction to linting
- 7:03Common linting checks
- 8:50Advanced rules and logic
- 12:09Structure and semantics
- 14:20Metrics and NLP in linting
- 15:33Tooling and implementation
- 18:18Adopting and maintaining rules
- 28:22Q&A: Balancing marketing/docs
- 37:18Q&A: Harmonizing experiences
related talks
25mAutomatic Checks for the People
53mAutomating Accessibility Assurance
29mBuilding Accessibility Testing into Your Workflow
28mPreventing headaches with linters and automated checks
22mEasier Lint Authoring with Semantic Search and (...)
27mRules_lint: Formatting and Linting All Languages
28mFixit linter+AI coding
31mDevelopment Standards: A Step-by-Step Guide to Implementing Them Without Pain