Designing UML diagrams for technical documentation

• Authors: Neil MacKinnon;Steve Murphy
• Venue: Proceedings of the 21st annual international conference on Documentation
• Year: 2003

This paper presents a framework for improving the presentation of Unified Modeling Language (UML) diagrams, as applied in technical documentation produced at the IBM Toronto Software Laboratory. UML diagrams are a key part of program design. They can enhance understanding of complex programming concepts, and assist in problem analysis and solution design. In turn, UML diagrams can add significant value to documentation, helping the user to understand not only the solution but also the reasons for using that particular solution. Too often, however, UML diagrams are created in isolation by a developer, with little or no thought as to how they will be presented in documentation, be it online, in a PDF file, or in a printed book. This compartmentalization does not allow for the possibility that a diagram that was useful in the design phase of a project will not necessarily bring value to documentation if its stated processes or goals are unclear. Poorly designed UML diagrams can also have a negative impact on both project scheduling and costs. For example, production delays can arise because of increased back-and-forth time among developers, writers, and designers, and translation costs can escalate if a diagram contains text that must be translated.This paper presents a method for ensuring a collaborative process for UML diagram design. It provides specific tasks for each of the three key roles in developing UML diagrams for documentation: program developer, technical writer, and graphic designer. It makes the program developer aware of design principles that might otherwise be overlooked. It shows the technical writer ways to improve the design of the diagram, and offers a method for converting files to a common format that can then be utilized by the graphic designer. Finally, it provides the graphic designer with a methodology for quickly producing a clear, error-free final image that is manageable in size. By following the guidelines presented here, developers, writers, and designers can work together to produce clean, concise UML diagrams that will bring value and clarity to technical information. This clearly defined process will help eliminate miscommunication, shorten development schedules, and reduce production and translation costs.