Rodrigo Guerreiro

"The purpose of a programming system is to make a computer easy to use", in The Mythical Man-Month
posts - 61, comments - 16, trackbacks - 14

I HATE writing documentation!!!

These past days I have be doing nothing else then writing documentation for several projects that I'm working in. Conclusion? It's like in the title of this post: I hate writing documentation. Why? Well because I'm a developer and not a writer; because it's boring and most of all because it's giving a all lot of work when probably no one will read it.

Finally I got that out of my chest...

If you are just like me then you may like to know that the pattern & practices team released in the CodePlex site a few documentation tools. For now it only includes a Word 2007 template and tools that you can use to convert Word documents to HTML, Help 1.0 (CHM), and Help 2.0 (HxS). It also includes a tool that helps to manage the table of contents for large documentation sets.

Hopefully, in the future, they will manage to develop some kind of a mind-reader-documentation-generator that will put out of my despair :)

 

Until next time ;)

Print | posted on Thursday, January 17, 2008 11:04 AM

Powered by: