Program documentation
-
I'd appreciate if any of you had input on tools for program documentation. I'm not thinking about manuals, installation guides, product sheets and what else our poor clients and others are bombarded with, but good old fashioned internal program documentation: Algorithms, Data structures, Tools, Dependencies, Databases, Compiler switches, etc, etc, etc. The lot! What i'm looking for is an effecient tool for a very small departement (headcount is two and a half) situated in one location. Ease of use is very high on the priority list. Flashy looking printed output is very low. Having googled around, i've reached three conclusions: 1) Word is the worst choice of all. 2) Wiki solutions are becoming increasingly popular. 3) Dedicated documentation tools are often very "corporate". As an experiment i tried out MoinMoin Wiki. It seemed ok but my hands never came over my head. Any thoughts? Søren
-
I'd appreciate if any of you had input on tools for program documentation. I'm not thinking about manuals, installation guides, product sheets and what else our poor clients and others are bombarded with, but good old fashioned internal program documentation: Algorithms, Data structures, Tools, Dependencies, Databases, Compiler switches, etc, etc, etc. The lot! What i'm looking for is an effecient tool for a very small departement (headcount is two and a half) situated in one location. Ease of use is very high on the priority list. Flashy looking printed output is very low. Having googled around, i've reached three conclusions: 1) Word is the worst choice of all. 2) Wiki solutions are becoming increasingly popular. 3) Dedicated documentation tools are often very "corporate". As an experiment i tried out MoinMoin Wiki. It seemed ok but my hands never came over my head. Any thoughts? Søren
May I suggest Sandcastle[^] to generate source-code level documentation? Pick a method name, and add three slashes above it;
///
void Main (string[] args)will generate a placeholder;
/// <summary>
///
/// </summary>
/// <param name="args"></param>
static void Main (string[] args)Plus the class-diagrams, that both Visual Studio and SQL Server can generate for you.
This works for me as a team, when this.teamSize == 1
-
I'd appreciate if any of you had input on tools for program documentation. I'm not thinking about manuals, installation guides, product sheets and what else our poor clients and others are bombarded with, but good old fashioned internal program documentation: Algorithms, Data structures, Tools, Dependencies, Databases, Compiler switches, etc, etc, etc. The lot! What i'm looking for is an effecient tool for a very small departement (headcount is two and a half) situated in one location. Ease of use is very high on the priority list. Flashy looking printed output is very low. Having googled around, i've reached three conclusions: 1) Word is the worst choice of all. 2) Wiki solutions are becoming increasingly popular. 3) Dedicated documentation tools are often very "corporate". As an experiment i tried out MoinMoin Wiki. It seemed ok but my hands never came over my head. Any thoughts? Søren
As Eddy says below if it's .NET code use Sandcastle. Also worth combining with GhostDoc and, if you can, the CR_Documentor plugin for Developer Express's DXCore - all free. For C++ Doxygen seems to be popular. I've not used it myself though.
Kevin