Tuesday, September 09, 2008

Improving technical documentation

Technical writers all over the world are debating on how new approaches and processes can dramatically improve the quality of the documentation produced.

A few suggest that Usability testing, even with limited resources, can add value to the documentation you produce. Other suggest moving documentation to the Web 2.0 model for ease of use and adopting agile documentation. There are people who cite Google's example of comic documentation when they released their new browser, the Chrome.

Daniel Brolund suggests User Guide driven documentation where a snippet of the user guide describing a new feature is prepared. This is an interesting idea in that the techncial writers get a chance to become involved in the documentation process at the initial stages of software development itself. Click here to read Daniel's post.

No comments:

Newspaper front pages - June 5

 Some images of front pages of newspapers after votes were counted on June 4, 2024 after a ridiculously long parliament elections.  Did the ...