Where are you documenting program flow?

[Brett]

I'd like to have all of my documentation in one place. I use the following
for documenting code:
- attributes for certain types of documentation
- use of the C# generated inline XML documentation
- simple comments

I also use Visual Paradigm for UML (class relationships), which integrates
with VS.NET. I need something for general documentation of program flow.
Any suggestions on what to use for this?

I would like to keep the code and all releated documentation together. I
suppose putting the UML project and program flow documentation into a
satellite assemblies would work. I think Visual Paradigm has something for
program flow.

How are you documenting program flow and keeping all of the documentation
together?

Thanks,
Brett

[Adam Norris]

Check out NDoc on sourceforge. I believe that it will satisfy the
using of the inline XML documentation (<summary>, <remarks>,
<param=""> etc...)

It can make the resulting documentation into a static web site that
looks like javadoc or MSDN OR if you have HTML Workshop SDK installed,
it can drop it right down to a CHM. The NDoc interface to generate
the resulting documentation is very nice as well.

Hope that helps and that I'm not too off of the topic!

--Adam

On Thu, 12 May 2005 10:13:07 -0400, "Brett" <[e-mail]> wrote:

I'd like to have all of my documentation in one place. I use the following
for documenting code:
- attributes for certain types of documentation
- use of the C# generated inline XML documentation
- simple comments

I also use Visual Paradigm for UML (class relationships), which integrates
with VS.NET. I need something for general documentation of program flow.
Any suggestions on what to use for this?

I would like to keep the code and all releated documentation together. I
suppose putting the UML project and program flow documentation into a
satellite assemblies would work. I think Visual Paradigm has something for
program flow.

How are you documenting program flow and keeping all of the documentation
together?

Thanks,
Brett