I'm new to freemind but used Inspiration for many years. I'm wondering if anyone can save me a lot of searching by providing advice hints on the following. I have a program of about 2K lines with two classes and maybe 25 methods. I now want to document the program with freeplane, showing all major methods and interfaces at a high level.
My first attempt was creating child nodes around the root to represent the classes and methods. However, I don't like that approach because it has everything connected to the root. I want the diagram to be the separate methods (& some of their variables) in more of a flow diagram, with each method being represented as an independent box. Then I would represent the local variables of each method as child nodes. The variables can then be connected between method nodes to show interaction.
Any ideas of the best way to model it? I was thinking I could just create floating/free nodes to represent the methods. However, I can see that there is a lot of functionality in Freeplane and there might be a better way.
Thanks
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
I now want to document the program with freeplane, showing all major methods
and interfaces at a high level...any ideas of the best way to model it?
I don't know if it is the best way to do it, but for me it is a very helpful way to do it. It helped me with a lot of projects during the recent years:
You see:
on the left is the clickable file name (a Groovy script)
then follow regions of application (UserInterface, and CODE)
the green text nodes resemble blockwise code descriptions (or functions if you will)
the red ones show where there are implementation issues / bugs
further right you see the variables / function calls used for realization (incoming and outgoing)
clicking the variables / functions jumps to their origin
...
Of course there are loads of little helpers for keyboard shortcuts and reference link creation, by now. But I started off doing all these things by hand. And I'm working on automating the entire process (building documentation maps from source code itself :-) .
What do you think? Any questions / any suggestions?
Last edit: nnako 2017-08-25
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
I'm new to freemind but used Inspiration for many years. I'm wondering if anyone can save me a lot of searching by providing advice hints on the following. I have a program of about 2K lines with two classes and maybe 25 methods. I now want to document the program with freeplane, showing all major methods and interfaces at a high level.
My first attempt was creating child nodes around the root to represent the classes and methods. However, I don't like that approach because it has everything connected to the root. I want the diagram to be the separate methods (& some of their variables) in more of a flow diagram, with each method being represented as an independent box. Then I would represent the local variables of each method as child nodes. The variables can then be connected between method nodes to show interaction.
Any ideas of the best way to model it? I was thinking I could just create floating/free nodes to represent the methods. However, I can see that there is a lot of functionality in Freeplane and there might be a better way.
Thanks
Hi Braves,
good to see your interest ;-)
I don't know if it is the best way to do it, but for me it is a very helpful way to do it. It helped me with a lot of projects during the recent years:
You see:
Of course there are loads of little helpers for keyboard shortcuts and reference link creation, by now. But I started off doing all these things by hand. And I'm working on automating the entire process (building documentation maps from source code itself :-) .
What do you think? Any questions / any suggestions?
Last edit: nnako 2017-08-25