Re: Documentation tools
- From: "Gerrit Beuze" <gerrit[at][-nospam]modelmakertools[dot]com>
- Date: Fri, 25 Jul 2008 13:02:28 +0200
1)the interaction/association of different modules
2)business flow of each module/functionality
What tools do I need?
I'd say
UML Static structure (class) diagrams for (1)
UML Activity / State diagrams for (2)
Perhaps with Interaction (sequence) diagrams for complex situations where timing is relevant
Tools:
If it is just for documentation and no need to generate code:
Uml Explorer (integrates in your Delphi IDE)
http://www.modelmakertools.com/uml-explorer/index.html
This will auto visualize most structural relations in a class diagrams
Automatic means: using a visualization wizard you select source fles,
select the classes to visualize and select the relations you want to see:
inheritance, using etc.) and a diagram is created on the fly.
If you want more Uml power and to be able to generate code too:
ModelMaker http://www.modelmakertools.com/modelmaker/index.html
might be a good choice. Especially with the currently reduced prices.
Any sample of such documentation?
No, but I would not make it too complex or detailed, limit yourself
to high levels and the absolute minimum to avoid the doc getting
out of sync or becoming too complex to understand.
With tools like above, it is easy to visualize any part of the app in more detail
when required.
Gerrit Beuze
ModelMaker Tools
.
- References:
- Documentation tools
- From: Man T
- Documentation tools
- Prev by Date: Re: A special group for Unicode discussion?
- Next by Date: Resource Optimization
- Previous by thread: Documentation tools
- Next by thread: Re: Documentation tools
- Index(es):
Relevant Pages
|
