Can anybody recommend a good documentation tool for VB.NET projects?



I am looking for something that helps me out write notes, busines rules explanation, etc for my forms, Business Objects, etc. Currently I am using MS Word to write down all my specs and annotations, but if such a tool exist for .NET that helps out simplify the documentation process per project I would like to start using it.

Edhy Rijo

I tend to follow a tactic similar to Peter's. I just use text files, and put them under version control. This allows me easy access and easy diffs. Not pretty though. I tend to use Word (or OpenOffice) if I need to communicate with the customer/business people.



I also like to keep all my SQL scripts under source control, though I don't put them within the solution. As mentioned by Trent in another post, if using the DDT, integrating the creation of a package during the build process, that then gets put under source control is seems like an excellent way to manage this also.



I also tend to just document much of this sort of thing directly in code, using XML comments (/// or '''). This makes the logic available within the object browser and you can use Sandcastle (which I haven't yet) to make msdn help files of your objects. By putting it directly within the code, it is easier to keep track of it, it tends to be were I need it, when I need it.



My system isn't perfect, so I'll be interested in any other ideas of how to manage this sort of documentation myself.

Thanks Greg. currently I am using the XML comments and then have the Obfuscator remove the comments. I am also googling some other documentation tools and will post here if find something interesting that will make our life a bit easier .

Edhy Rijo