We're sorry but this page doesn't work properly without JavaScript enabled. Please enable it to continue.
Feedback

Automated Documentation Proofreading

Formal Metadata

Title
Automated Documentation Proofreading
Subtitle
igor: Making Documentation Easier
Title of Series
Number of Parts
24
Author
License
CC Attribution - NonCommercial - ShareAlike 3.0 Unported:
You are free to use, adapt and copy, distribute and transmit the work or content in adapted or unchanged form for any legal and non-commercial purpose as long as the work is attributed to the author in the manner specified by the author or licensor and the work or content is shared also in adapted form only under the conditions of this
Identifiers
Publisher
Release Date2012
LanguageEnglish

Content Metadata

Subject Area
Genre
Abstract
Making documentation easier and better by automating tests for errors in language, formatting, and usage. Few people like to work on documentation. There are numerous rules for wildly-varying documentation formats, many rarely used and hard to remember. An automatic proofreader to check for errors ranging from spelling to meeting all the arcane formatting rules of the different toolchains would relieve much of the stress. Not only will this encourage improving the documentation, it helps to prevent errors in the first place, and detect those that have slipped through already. Clean, consistent files are easier to maintain, expand, and convert to new formats. The automated proofreader, named "igor" after a famous lab assistant, helps the writer focus on improving the content of their document.