Originally posted by vivek ja:
I am currently working on an application that is written in java.
I have been asked to take over this application and enhance this.
I feel if there is good documentation in terms of the design, like what classes are there the methods in each class and what each method does, it will be good for someone to read this and understand what the application is doing instead of going through the code.
I know that design shouldve been done before writing the code, but as we all know, is not always the case in real life :-) So I want to start documenting it so that the next person will find it easier to maintain this code.
One way I can think of is, writing the classes, methods in each, dependencies between classes. But this approach has me confused because it goes on and on, with one calling the other and that calling the next and so on.
Is there any clean approach to this kind of thing? Are there any steps to do this?
I know that there are features in some design tools to generate design from code, but unfortunately I have only MS word :-)
Let me know if any of you have done this or have any thoughts on this kind of thing.