Need advice on how to document programs
Posted on 2011-10-20
I know basic stuff about UML:
- Use Case
- Activity Diagram
- Class Diagram
- Sequence diagram
All of them seem great to me. I can have a general "vision" or "understanding" of a system or application. But just "general".
Think about this example: a programmer has to deal with an application for the first time. All UML documents that I mentioned will help him to have a general understanding of the system. But one day his boss says to him: "There is a problem with the "payroll process", check it."
The programmer will have to talk with the user and try to understand in which form the user has found the problem. It was Form_Payr.1.2.aspx, when clickling button "Ok". Then programmer will return to his seat and have to review what is going on in Form_Payr.1.2.aspx, what classes and methods are invoked from its vb code, if process is executed in the Business Layer or in stored procedures at database, and finally get what is the problem. The programmer does all of these tasks only with IDE and debugging.
My question are:
- Is there any UML document or diagram that will map what programs (vb or aspx) call what clasess or methods, and what processes they run, so it would be easier or faster to do maintenance.
- Is there any best practice about how document this kind of maps?