Sequence diagram presentation in technical documentation

  • Authors:
  • Gary Bist;Neil MacKinnon;Steve Murphy

  • Affiliations:
  • IBM Toronto Software Laboratory, Markham, Ontario;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

Quantified Score

Hi-index 0.00

Visualization

Abstract

A sequence diagram shows a series of events that occurs within a particular system. A sequence diagram can be extremely useful for design and analysis, since it shows logic flow visually. However, because even a simple programming sequence can stretch far beyond the confines of a single screen or printed page, authors of technical material must be able to identify and apply a set of best practices. The set of practices developed for the IBM Toronto Software Laboratory enables authors to reasonably present such diagrams within the limited confines of the publishing medium. Building on the work presented in the article "Designing UML diagrams for technical documentation" [1], this paper discusses an approach for dealing with the particular challenges of presenting sequence diagrams in technical documentation.