From Fedora Project Wiki
(→What to look for when reviewing a guide: Added repeated words.) |
|||
| Line 9: | Line 9: | ||
* Compliance with Fedora Documentation style guide | * Compliance with Fedora Documentation style guide | ||
* Documented procedures do what they say they do without eating babies. | * 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? | |||
[[Category:Docs QA]] | [[Category:Docs QA]] | ||
Revision as of 17:26, 28 November 2011
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?