Docs QA Review Guidelines
From FedoraProject
This is the start to the Docs QA guidelines...
What to look for when reviewing a guide
- Broken links
- Appropriate license
- Misspelled words
- Repeated words (E.g. 'the the')
- Grammar
- Compliance with Fedora Documentation style guide
- Documented procedures do what they say they do without eating babies.
Automation
Some of these checks can be automated, others by their nature can not. The script File:Qa check.sh provides an example of how DocBook XML might be automatically checked for:
- Misspelled words
- Repeated words
It also currently checks for use of entities outside the Feedback / Legal Notice / Book Info files. This script could also be extended to check for:
- Broken links
- Contractions
- Suggestions welcome?
Usage:
- Run qa_check.sh from within the book's root directory, for example musicians-guide/, to check the whole book.
- Run qa_check.sh FILENAME to check a single file.
