More Web Proxy on the site http://driver.im/

Article

Documenting software systems with views II: an integrated approach based on XML

Authors:

Jochen Hartmann,

Scott TilleyAuthors Info & Claims

SIGDOC '01: Proceedings of the 19th annual international conference on Computer documentation

Pages 237 - 246

https://doi.org/10.1145/501516.501571

Published: 21 October 2001 Publication History

Abstract

Software engineers rely on program documentation as an aid in understanding the functional nature, high-level design, and implementation details of complex applications. Without such documentation, engineers are forced to rely solely on source code. This is a time-consuming and error-prone process, especially when one considers the amount of information assimilation and domain mapping that is required to understand the architecture of a large-scale software system. This paper describes an integrated approach to documenting software systems based on XML. In particular, the paper focuses on the creation and use of specific Document Type Definitions (DTD) that are defined by MSR as a standard for software documentation. MSR is a consortium of several German automotive companies whose goal is to support cooperative development between car manufacturers and their electronic system suppliers. To illustrate the approach, selected aspects of the document creation process for an engine control system are presented.

References

[1]

AT&T Research. "The Dot Graph Visualization Program." Online at www.graphviz.org.

[2]

Beck, K. Extreme Programming Explained: Embrace Change. Addison-Wesley, 1999.

Digital Library

[3]

Chikofsy, E.; and Cross, J. "Reverse Engineering and Design Recovery: A Taxonomy." IEEE Software 7(1):13-17, January 1990.

Digital Library

[4]

ETAS GmbH. "ASCET SD." Online at www.etas.de.

[5]

Manger, G. "A Generic Algorithm for Merging XML/SGML Instances.' XML Europe 2001.

[6]

Microsoft Corp. "Internet Explorer." Online at www.microsoft.com/windows/ie.

[7]

Microsoft Corp. "Office XP Professional." Online at www.microsoft.com/office.

[8]

Microsoft Corp. "Visio: The Office Business Diagramming Solution." Online at www.microsoft.com/office/visio.

[9]

MSR MEDOC. Online at www.msr-wg.de/medoc.html.

[10]

Smith, D.; Thomas, B.; and Tilley, S. "Documentation for Software Engineers: What is Needed to Aid System Understanding?" Proceedings of the 19 th International Conference on System Documentation (SIGDOC 2001: October 21-24, 2001; Santa Fe, NM). New York, NY: ACM Press, 2001.

Digital Library

[11]

SoftQuad Corp. "XMetal 2: The Premier XML Content Enabler." Online at www.softquad.com.

[12]

Tilley, S. and M~ller, H. "INFO: A Simple Document Annotation Facility." Proceedings of the 9 th Annual International Conference on System Documentation (SIGDOC'91: October 10- 12 1991; Chicago, IL), pp. 30-36. New York, NY: ACM Press, 1991.

Digital Library

[13]

Tilley, S.; M~ller, H.; and Orgun, M. "Documenting Software Systems with Views." Proceedings of the 10 th Annual International Conference on System Documentation (SIGDOC'92: October 13-16 1992; Ottawa, Canada;), pp. 211- 219. New York, NY: ACM Press, 1992.

Digital Library

[14]

Tilley, S.; Whitney M.; M~ller H. and Storey M.-A. "Personalized Information Structures", Proceedings of the 11 th International Conference on System Documentation (SIGDOC'93: October 5-8, 1993; Waterloo, Canada), pp 325-337. New York, NY: ACM Press, 1993.

Digital Library

[15]

United States Congress. "XML and Legislative Documents." Online at xml.house.gov.

[16]

W3C. HTML. Online at www.w3.org/MarkUp.

[17]

W3C. XML. Online at www.w3.org/XML.

[18]

W3C. XSLT. Online at www.w3.org/Style/XSL.

[19]

Weichel, B. "Strategies for Implementing SGML/XML as a Glue Layer in Engineering Process." SGML/XML Europe 1998.

[20]

Wong, K.; Tilley, S.; M~ller, H.; and Storey, M.-A. "Structural Redocumentation: A Case Study," IEEE Software 12(1):46-54, January 1995.

Digital Library

Cited By

Gendreau ORobillard PMünch JLan JZhang H(2013)A process practice to validate the quality of reused component documentation: a case study involving open-source componentsProceedings of the 2013 International Conference on Software and System Process10.1145/2486046.2486059(61-69)Online publication date: 18-May-2013
https://dl.acm.org/doi/10.1145/2486046.2486059
Tilley SMehlenbacher BProtopsaltis AWilliams ASlattery S(2009)Documenting software systems with views VIProceedings of the 27th ACM international conference on Design of communication10.1145/1621995.1622043(239-244)Online publication date: 5-Oct-2009
https://dl.acm.org/doi/10.1145/1621995.1622043
Díaz OAnfurrutia FKortabitarte JBorghoff UChidlovskii B(2009)Using DITA for documenting software product linesProceedings of the 9th ACM symposium on Document engineering10.1145/1600193.1600244(231-240)Online publication date: 16-Sep-2009
https://dl.acm.org/doi/10.1145/1600193.1600244
Show More Cited By

Index Terms

Documenting software systems with views II: an integrated approach based on XML
1. Software and its engineering
  1. Software creation and management
    1. Software post-development issues
      1. Documentation
      2. Software reverse engineering

Recommendations

Documenting software systems with views
SIGDOC '92: Proceedings of the 10th annual international conference on Systems documentation

Software professionals rely on internal documentation as an aid in understanding programs. Unfortunately, the documentation for most programs is usually out-of-date and cannot be trusted. Without it, the only reliable and objective information is the ...
Automating testing by reverse engineering of software documentation
WCRE '95: Proceedings of the Second Working Conference on Reverse Engineering

Reverse engineering of software documentation can play an important role in automating software testing. Since testers often compare the operation of a software system to the expected behavior as described in a document, information extraction from ...
Documenting software systems with views VI: lessons learned from 15 years of research & practice
SIGDOC '09: Proceedings of the 27th ACM international conference on Design of communication

A "view" is a form of graphical documentation representing some aspect of a software system. Views can be an important aid in helping to understand large-scale applications, and can be automatically produced through reverse engineering. This paper ...

Comments

Please enable JavaScript to view thecomments powered by Disqus.

Information & Contributors

Information

Published In

cover image ACM Conferences

SIGDOC '01: Proceedings of the 19th annual international conference on Computer documentation

October 2001

272 pages

ISBN:1581132956

DOI:10.1145/501516

Conference Chairs:
Mary Jane Northrop
Enlighten, USA
,
Scott Tilley
University of California, Riverside, CA

Copyright © 2001 ACM.

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]

Sponsors

SIGDOC: ACM Special Interest Group for Design of Communications

Publisher

Association for Computing Machinery

New York, NY, United States

Publication History

Published: 21 October 2001

Permissions

Request permissions for this article.

Request Permissions

Check for updates

Author Tags

Qualifiers

Article

Conference

SIGDOC01

Sponsor:

SIGDOC

SIGDOC01: 19th International Conference on Systems Documentation

October 21 - 24, 2001

New Mexico, Sante Fe, USA

Acceptance Rates

Overall Acceptance Rate 355 of 582 submissions, 61%

Contributors

Other Metrics

View Article Metrics

Bibliometrics & Citations

Bibliometrics

Article Metrics

11
Total Citations
View Citations
693
Total Downloads

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

Reflects downloads up to 30 Dec 2024

Other Metrics

View Author Metrics

Citations

Cited By

Gendreau ORobillard PMünch JLan JZhang H(2013)A process practice to validate the quality of reused component documentation: a case study involving open-source componentsProceedings of the 2013 International Conference on Software and System Process10.1145/2486046.2486059(61-69)Online publication date: 18-May-2013
https://dl.acm.org/doi/10.1145/2486046.2486059
Tilley SMehlenbacher BProtopsaltis AWilliams ASlattery S(2009)Documenting software systems with views VIProceedings of the 27th ACM international conference on Design of communication10.1145/1621995.1622043(239-244)Online publication date: 5-Oct-2009
https://dl.acm.org/doi/10.1145/1621995.1622043
Díaz OAnfurrutia FKortabitarte JBorghoff UChidlovskii B(2009)Using DITA for documenting software product linesProceedings of the 9th ACM symposium on Document engineering10.1145/1600193.1600244(231-240)Online publication date: 16-Sep-2009
https://dl.acm.org/doi/10.1145/1600193.1600244
Kienle H(2008)Component-based tool development2008 Frontiers of Software Maintenance10.1109/FOSM.2008.4659252(87-98)Online publication date: Sep-2008
https://doi.org/10.1109/FOSM.2008.4659252
Mohamed A(2007)Managing Evolution in Software-Engineering Knowledge Management Systems2006 1st International Conference on Digital Information Management10.1109/ICDIM.2007.369324(19-24)Online publication date: Apr-2007
https://doi.org/10.1109/ICDIM.2007.369324
Aguiar ADavid GRiehle D(2005)WikiWiki weaving heterogeneous software artifactsProceedings of the 2005 international symposium on Wikis10.1145/1104973.1104980(67-74)Online publication date: 16-Oct-2005
https://dl.acm.org/doi/10.1145/1104973.1104980
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
Hardung BKölzow TKrüger AButtazzo G(2004)Reuse of software in distributed embedded automotive systemsProceedings of the 4th ACM international conference on Embedded software10.1145/1017753.1017787(203-210)Online publication date: 27-Sep-2004
https://dl.acm.org/doi/10.1145/1017753.1017787
Huang STilley SJones SNovick D(2003)Towards a documentation maturity modelProceedings of the 21st annual international conference on Documentation10.1145/944868.944888(93-99)Online publication date: 12-Oct-2003
https://dl.acm.org/doi/10.1145/944868.944888
Tilley SHuang SHaramundanis KPriestley M(2002)Documenting software systems with views IIIProceedings of the 20th annual international conference on Computer documentation10.1145/584955.584988(226-233)Online publication date: 20-Oct-2002
https://dl.acm.org/doi/10.1145/584955.584988
Show More Cited By

View Options

Login options

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

Full Access

Get this Publication

View options

PDF

View or Download as a PDF file.

eReader

View online with eReader.

Media

Figures

Other

Tables

View Table of Contents