CodeBetter.Com
CodeBetter.Com
RSS 2.0 via Feedburner
           Do you Twitter? Follow us @CodeBetter

Grant Killian's Blog

No, this has nothing to do with beer -- but maybe it should?

Technical Documentation Nirvana

One project I'm working on is approaching the exciting “ready for external beta testers” phase.  Like too many projects, the original design documents are scattered and haven't been updated.  I've been tasked with mapping a course to technical documentation nirvana, with scarce resources to utilize; my primary responsibilities are to final product polishing and working with the Sales group as to product direction, etc -- this course will be taken by a more junior person under my limited supervision, but they're familiar with the product so they'll do fine.

Nirvana would consist of being able to bring other developers up to speed quickly with the help of this technical documentation.

The old docs are so bad that I'm acting as if they don't exist.  I know C# comments will produce a form of technical documentation (HTML and all that), and combined with a database diagram (from SQL Server), this may be the path of least resistance.  I know there are reverse engineering tools out there and other modeling systems I could use, but I'm not convinced.

Before starting down this road, I'm curious as to what others have used to achieve some measure of Tech Doc Nirvana?  Any bodhisattvas out there?

Happy .Netting!



Leave a Comment

(required)  
(optional)
(required)  

Enter the numbers above:
Add
Check out Devlicio.us!