Open source software developers need to give credit and respect to documentation developers. The hard work needed for technical documentation is underappreciated. Unfortunately, the prevelant attitude among software developers is to install a Wiki and depend on the good will of others to document their projects.
Wikis do not work for technical documentation. For technical documentation to be usable it must be clear, complete, correct and current. Wikis fail on all of these points.
:: CLEAR
Most technical documentation Wikis are a mess. They are an unorganized pile of articles that can duplicate or contradict each other. Most Wikis are unmanaged by anybody responsible enough to purge the junk and reorganize the entries. I lament the revert war that may follow anyone brave enough to attempt to the clean the mess up.
The ‘search’ feature of most Wikis is inadequate. Multiple words in a search phrase causes the search engine to lose its brain. If your phrase does not match the words of entries exactly, the search engine will not be able to find what you need. You often can have better luck with a Google search.
:: COMPLETE
Wiki zealots want documentation to be incomplete. They feel the best way to encourage participate is to post stubs. Stubs are woefully inadequate articles that are the Wiki equivalent of the “under construction” signs once popular on web pages. Remember those? Stubs are just as pointless.
:: CORRECT
Not too long ago Google announced a project to scan in books and make their digitized contents searchable. Why not? Books have been subjected to the scrutiny of an editorial review. The author’s name is prominently displayed on the book.
Software developers have their superstars such as Alan Cox and Linus Torvalds. Can you name a technical documentation author whose work is as respected? Technical documentation Wikis do not reward either editorial scrunity or correctness. In fact who wants their name associated with anything that can be changed so easily to be incorrect.
:: CURRENT
A neglected Wiki is not a good source of current documentation. In fact technical documentation in general usually trails the release of project software. I challenge open source developers to make technical documentation a part of a ‘release’. In other words a software project is not ready for release until its technical documentation is updated. I am frustrated by outdated documentation in projects like Gnome and Cloudscape.
:: WHAT TO DO
Open source projects must find a documentation maintainer. That person is a developer — a documentation developer — who is just as important as any developer actively working on source code. Consider her part of your team. Give her CVS privileges. Answer her questions quickly and in a friendly manner. Give her credit in your project documentation and on your project web site.
A documentation maintainer’s job is to handle document submissions. He ensures that your documentation is clear, complete, correct, current, and consistent. Also, users may find a bug but will complain that the manual is wrong. If he cannot explain a feature, it may be a usability problem with your interface.
Wikis suck for technical documentation. But with the right attitude and a serious commitment open source projects can have decent technical documentation.