Goal: 24 minutes
2 Intro
Questions to answer:
4 UI Overview
4 Packages
4 Clusters
4 User Index
4 Cookbook
2 Conclude
Spend about 3 minutes per slide
Have a title page
Have a table of contents
Maybe, for the introduction, show a screen shot of Argo/UML
----------------------------
Initial Thoughts: The goal of this is to show that I would be able to maintain the support and the documentation of this software. The first thing to cover is who my audience is. This documentation caters to the person who is not familiar with the code and would like to modify and extend the capabilities of Argo/UML. Therefore, a lot of this is covered in a overview manner, shying away from too much detail. In order to make this pass, what was kept in mind is that different people learn in different ways. In order to help each of these diffent types of people, it is necessary to arrange the documentation in five different paradigms: The Cookbook paradigm in which people can learn from specific examples of implementing specific parts of code, the Clusters paradigm is where we take a look at the inheritance hierarchies of groups of classes that are likely to be subclassed to add additional functionality (FigNodeModelElement for example). A good way to come up with important clusters of classes is to look at the future vision of the application (what still needs to be implemented) and then choose clusters accordingly. Organizational paradigm is where we take a look at and explain what all of the packages are used for, and why they are organized the way they are. This will give someone a good idea what classes to look at when modifying the code. Then there is the Graphical paradigm where by clicking on various places of the Argo/UML main window, you will be introduced to a potpourri of all the above. Lastly, there is the Explanatory paradigm, where important pieces of the code and how it works is explained, things suchs as event handling and managers that play important roles in the coding. One could just find all of these things out, eventually, just by tracing through all of the code. But if a good overview is given, then I think that much time can be saved discovering things that can be explained in a overview. Another idea, maybe for the future, would be to have the creator of the application be taped while explaining his code design, what needs to be implemented, future visions, and why it was designed the way it was. |
How is code organized into directories and files?
How is code organized into classes and inheritance hierarchies?
The Argo/UML main window, and the code associated with it.
How does the current code work?
Go to here to visit the Argo/UML Homepage