Improving architecture documentation management with object-oriented tools

Sammanfattning

Architectural documentation is crucial in the development process, as it helps developers understand the system’s architecture and make informed decisions. However, conventional documentation methods are often timeconsuming and error-prone since most of the work is done manually. This becomes even more ambiguous whendealing with complex systems and when requirements are prone to changing during the development process. This thesis addresses these challenges by exploring the potential benefits of utilizing object-oriented documentation tools and plugins to improve the efficiency of writing and maintaining architectural documentationwhile also making sure that the conveyed information is sufficient and understandable for junior developers. Moreover, it investigates the possibility of generating an easy-to-maintain context view with the use of metadatato display architectural information. The thesis employs both a qualitative case study as well as a rapid application development (RAD) approach.The case study involves interviewing junior developers to find patterns in what junior developers look for inregards to understanding a system’s architecture. Using the RAD approach, a prototype system is developedthat utilizes DollarDoc to treat documentation components as objects by being able to refer to these objectsfrom one file to another. The result shows how architectural documentation can be designed to effectively communicate critical aspects of the system’s architecture to junior developers by providing a clear overview of its components. Thiscontributes to a better understanding of the system’s functionality and purpose, leading to increased productivity and engagement. By using object-oriented documentation tools, the documentation structure becomesmore maintainable, allowing for automatic updates and reliable information.