BSDCan2012 - Slide Update J
BSDCan 2012
The Technical BSD Conference
Speakers | |
---|---|
Warren Block |
Schedule | |
---|---|
Day | Talks - 1 - 2012-05-11 |
Room | MRT 256 |
Start time | 11:30 |
Duration | 00:30 |
Info | |
ID | 352 |
Event type | Lecture |
Track | FreeBSD Developers Summit |
Language used for presentation | English |
Automated Documentation Proofreading
igor: Making Documentation Easier
Automated Documentation Proofreading
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.