Designing UML diagrams for technical documentation: continuing the collaborative approach to publishing class diagrams

Authors:
Neil MacKinnon;Steve Murphy
Affiliations:
IBM Toronto Software Laboratory, Markham, Ontario;IBM Toronto Software Laboratory, Markham, Ontario
Venue:
Proceedings of the 22nd annual international conference on Design of communication: The engineering of quality documentation
Year:
2004

Citing 1
Cited 5

Designing UML diagrams for technical documentation

Proceedings of the 21st annual international conference on Documentation

Designing UML and UML-based diagrams for technical documentation: where are we now?

Proceedings of the 26th annual ACM international conference on Design of communication
Globalization of graphics: delineating a research into using the scalable vector graphics file format to improve the translation of graphics

Proceedings of the 26th annual ACM international conference on Design of communication
A development method of UML documents from requirement specifications using NLP

International Journal of Computer Applications in Technology
A Proposal of Adequate and Efficient Designing of UML Documents for Beginners

KES '07 Knowledge-Based Intelligent Information and Engineering Systems and the XVII Italian Workshop on Neural Networks on Proceedings of the 11th International Conference
Probing the use of charts and graphs in technical documentation through analysis and pragmatic collaboration

Proceedings of the 27th ACM international conference on Design of communication

Quantified Score

Hi-index	0.00

Visualization

Abstract

This paper provides an updated discussion of the authors' ongoing efforts in developing a design framework for UML diagrams in technical documentation. 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 a previous paper, "Designing UML diagrams for technical documentation" [1], the authors presented a collaborative process that applies established design principles to UML diagrams, improving diagram presentation and shrinking publication costs and schedules. This paper expands on that work, showing how the established process can now be applied to several different modeling tools, including IBM Rational® XDE and Microsoft Visio. It also provides a detailed description of how to export modeling files to other file formats. The authors show how their process workflow has evolved over the past year as it has been applied by developers, writers, and graphic designers at IBM's Toronto Software Laboratory, and discuss ways in which they will continue to monitor and improve the efficacy of both the process and resulting diagrams.