Article

4th workshop on graphical documentation: UML style guidelines

Authors:

SIGDOC '04: Proceedings of the 22nd annual international conference on Design of communication: The engineering of quality documentation

Pages 118 - 119

https://doi.org/10.1145/1026533.1026564

Published: 10 October 2004 Publication History

Get Access

Abstract

The Unified Modeling Language (UML) is the de facto standard for visually representing modern software systems. This workshop will explore UML style guidelines and their effect on the efficacy of UML diagrams in the context of graphical program documentation. This work is part of an ongoing research program focused on assessing system redocumentation techniques. The workshop is a sequel to workshops held at SIGDOC 2001, SIGDOC 2002, and IWPC 2003.

References

[1]

Ambler, S. The Elements of UML Style. Cambridge University Press, 2003.

Digital Library

Google Scholar

[2]

Object Management Group (OMG). "UML Resource Page". Online at http://www.omg.org/uml.

Google Scholar

[3]

Huang, S. and Tilley, S. "Workshop on Graphical Documentation for Programmers: Assessing the Efficacy of UML Diagrams for Program Understanding." Held in conjunction with The 11th International Workshop on Program Comprehension (IWPC 2003: May 10, 2003; Portland, OR).

Digital Library

Google Scholar

[4]

MacKinnon, N. and Murphy, S. "Designing UML Diagrams for Technical Documentation." Proceedings of the 21st Annual International Conference on Design of Communication (SIGDOC 2003: October 12-15, 2003; San Francisco, CA), pp. 105--112. ACM Press: New York, NY, 2003.

Digital Library

Google Scholar

[5]

Tilley, S. and Wong, K. "Workshop on Graphical Documentation for Programmers." Held in conjunction with The 20th Annual International Conference on Systems Documentation (SIGDOC 2002: October 21, 2002; Toronto, Canada).

Digital Library

Google Scholar

[6]

Tilley, S.; Smith, D.; and Thomas, B. "Documentation for Software Engineers: What is Needed to Aid System Understanding?" Held in conjunction with The 19th Annual International Conference on Systems Documentation (SIGDOC 2001: Santa Fe, NM; October 21-24, 2001).

Digital Library

Google Scholar

[7]

University of Chicago Press Staff (editors). The Chicago Manual of Style (15th Edition). University of Chicago Press, 2003.

Google Scholar

Cited By

View all

Reynoso LManso EGenero MPiattini M(2019)Assessing the influence of import-coupling on OCL expression maintainabilityInformation Sciences: an International Journal10.1016/j.ins.2010.06.028180:20(3837-3862)Online publication date: 6-Jan-2019
https://dl.acm.org/doi/10.1016/j.ins.2010.06.028
Tilley SMurphy SHuang STilley SNewman R(2005)5th international workshop on graphical documentationProceedings of the 23rd annual international conference on Design of communication: documenting & designing for pervasive information10.1145/1085313.1085317(4-5)Online publication date: 21-Sep-2005
https://dl.acm.org/doi/10.1145/1085313.1085317
Distante DTilley SHuang STilley SHuang S(2004)Documenting software systems with views IVProceedings of the 22nd annual international conference on Design of communication: The engineering of quality documentation10.1145/1026533.1026544(33-40)Online publication date: 10-Oct-2004
https://dl.acm.org/doi/10.1145/1026533.1026544

Index Terms

4th workshop on graphical documentation: UML style guidelines
1. Software and its engineering
  1. Software creation and management
    1. Software post-development issues
      1. Documentation
      2. Software reverse engineering

Recommendations

Designing UML diagrams for technical documentation
SIGDOC '03: Proceedings of the 21st annual international conference on Documentation

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 ...
Designing UML diagrams for technical documentation: continuing the collaborative approach to publishing class diagrams
SIGDOC '04: Proceedings of the 22nd annual international conference on Design of communication: The engineering of quality documentation

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 ...
Designing UML and UML-based diagrams for technical documentation: where are we now?
SIGDOC '08: Proceedings of the 26th annual ACM international conference on Design of communication

UML diagrams are used to model real-world ideas and help users understand complex programming concepts. Developers and writers need to produce well-formed UML diagrams that can convey these ideas, and that are suitable for publishing in technical ...

Comments

Please enable JavaScript to view thecomments powered by Disqus.

Information & Contributors

Information

Published In

SIGDOC '04: Proceedings of the 22nd annual international conference on Design of communication: The engineering of quality documentation

October 2004

160 pages

ISBN:1581138091

DOI:10.1145/1026533

General Chair:
Scott Tilley
Florida Institute of Technology, USA
,
Program Chair:
Shihong Huang
Florida Atlantic University, USA

Permission to make digital or hard copies of all or part of this work for personal or classroom use is granted without fee provided that copies are not made or distributed for profit or commercial advantage and that copies bear this notice and the full citation on the first page. Copyrights for components of this work owned by others than ACM must be honored. Abstracting with credit is permitted. To copy otherwise, or republish, to post on servers or to redistribute to lists, requires prior specific permission and/or a fee. Request permissions from [email protected]

Publisher

Association for Computing Machinery

New York, NY, United States

Publication History

Published: 10 October 2004

Permissions

Request permissions for this article.

Request Permissions

Check for updates

Author Tags

Qualifiers

Article

Conference

SIGDOC04

Sponsor:

SIGDOC04: ACM 22nd Annual International Conference on Documentation 2004

October 10 - 13, 2004

Tennessee, Memphis, USA

Acceptance Rates

Overall Acceptance Rate 355 of 582 submissions, 61%

Contributors

Other Metrics

View Article Metrics

Bibliometrics & Citations

Bibliometrics

Article Metrics

3
Total Citations
View Citations
341
Total Downloads

Downloads (Last 12 months)2
Downloads (Last 6 weeks)0

Reflects downloads up to 30 Dec 2024

Other Metrics

View Author Metrics

Citations

Cited By

View all

Reynoso LManso EGenero MPiattini M(2019)Assessing the influence of import-coupling on OCL expression maintainabilityInformation Sciences: an International Journal10.1016/j.ins.2010.06.028180:20(3837-3862)Online publication date: 6-Jan-2019
https://dl.acm.org/doi/10.1016/j.ins.2010.06.028
Tilley SMurphy SHuang STilley SNewman R(2005)5th international workshop on graphical documentationProceedings of the 23rd annual international conference on Design of communication: documenting & designing for pervasive information10.1145/1085313.1085317(4-5)Online publication date: 21-Sep-2005
https://dl.acm.org/doi/10.1145/1085313.1085317
Distante DTilley SHuang STilley SHuang S(2004)Documenting software systems with views IVProceedings of the 22nd annual international conference on Design of communication: The engineering of quality documentation10.1145/1026533.1026544(33-40)Online publication date: 10-Oct-2004
https://dl.acm.org/doi/10.1145/1026533.1026544

View Options

Login options

Check if you have access through your login credentials or your institution to get full access on this article.

Cited By

Index Terms

Recommendations

Designing UML diagrams for technical documentation

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

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