This question about Documentation: Answered

diagram of the source code/runtime-application-structure

To improve the Software-Documentation, would a graphical presentation of the compile-time and run-time software-structure, something like a diagram in UML-notation, help in the debugging and developing process?

Of course, you can read the whole code, but i think an diagram would simplify the understanding.

If i get the time and understand enough(so I'm a newbie and are learning perl at the moment), i would try it.

This isn't a request, only an idea.

-- StephaniePlatz - 20 Apr 2009
Perhaps. I have tried to draw such a diagram (or more accurately, large set of diagrams) several times, and given up, but don't let that stop anyone else from giving it a go!

-- CrawfordCurrie - 20 Apr 2009

Just a thought to add to this: DirectedGraphPlugin uses Graphviz, and among its gallery of sample graphs there is one intended for software maintenance.

-- SeanMorgan - 22 Apr 2009

I know the DirectedGraphPlugin and I like the idea. But the output isn't very well-arranged and you have one picture of the hole thing. I like the idea behind DirectedGraphWebMapPlugin , that you can jump within the diagram to the documentation.

The most cool thing would be something like a java applet with such a diagram, but you can browse in it and can arrange yourself what you want so see and what not, can stretch and compress parts of the diagram...

Also would be cool, if you hasn't only a link to the user-documentation, but also the source-code, this also structured with twisty-like show and hide function, like in the notepad++ editor.

But that would be extreme complicated.

I'm glad, if I get my installation work smoothly and understand how the things work. So I don't think I'm able to do something like that, but I like the idea.

-- StephaniePlatz - 19 May 2009

Then you might want to build it on FreeMind:

-- SeanMorgan - 19 May 2009

QuestionForm edit

Subject Documentation
Status Answered
Topic revision: r6 - 19 May 2009, SeanMorgan - This page was cached on 13 May 2019 - 14:45.

The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. See Copyright Statement. Creative Commons License    Legal Imprint    Privacy Policy