Documentation Workflows
Testing Tools
1 min
the importance of testing documentation was already covered in the docid\ fuvopfyzcmrevxg3yks y section the following lists offers some ideas of things you can test for and some suggestions of tools to use grammar, punctuation, spelling https //www grammarly com ai powered writing assistant that checks for grammar, punctuation, and spelling errors https //prowritingaid com style and grammar checker with in depth reports on writing mechanics https //vale sh/ a customizable, command line linter for prose that enforces style guides the built in spellchecker of your authoring tool style and readability http //www hemingwayapp com highlights long, complex sentences and suggests simpler alternatives https //readable com analyzes text readability using various readability scores (flesch kincaid, gunning fog, etc ) links and navigation https //www screamingfrog co uk/seo spider/ crawls websites to audit links, images, scripts, and more https //validator w3 org/checklink checks the validity of links on a webpage http //home snafu de/tilman/xenulink html a legacy windows tool that scans entire websites for broken links has the added bonus of working offline too the built in reports of your authoring tool compliance and accessibility https //www deque com/axe/ browser extension or cli that tests web content for accessibility issues https //wave webaim org web accessibility evaluation tool that provides visual feedback about accessibility problems some of these tool need manual intervention and decisions; in other cases, testing can be automated as part of a ci/cd pipeline remember that you can always write your own custom tests too (either by yourself or with the help of a friendly neighborhood dev or ai tool)
🤔
Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.