Treffer: Software Documentation Management In Software Maintenance Phase- A Case Study of A Judicial Operating System in a Court

Many important government information systems have been built through outsourcing in the past years. Government official plays the role of the coordinator between the user and the maintenance staff. For government official, the software documentation is important for them to learn about an information system. It seems to be that the system provider does not have a good documentation solution yet, since software documentation is somewhat a touchy issue. This problem leads to that the government official can?t solve user?s problems efficiently in maintaining an outsourced information system. In this thesis, we will try to propose a source code documentation solution to assisting the government official to be familiar with an information system. We particularly focus on a judicial operating system based on the Java Server Page (JSP) software architecture in a court. The proposed documentation approach is constructed by referring to the program source code and the database dictionary. Additionally, we also design a series of tags for embedding useful information in the comments of source program. The proposed approach to documentation could assist the government official to be quickly familiar with the outsourced information system. In this thesis, we also implement an experimental source code documentation utility for a judicial operating system to demonstrate our proposed approach.