Article

Experience paper: a content reuse documentation design experience

Authors:

Kathy Haramundanis,

Larry RowlandAuthors Info & Claims

SIGDOC '07: Proceedings of the 25th annual ACM international conference on Design of communication

Pages 229 - 233

https://doi.org/10.1145/1297144.1297193

Published: 22 October 2007 Publication History

Get Access

Abstract

Using an XML environment, these authors as co-writers developed a set of documents that reused content in several ways. The documents produced for a HP software product included a user manual, context-sensitive help for product GUI screens and user tasks, manual pages (manpages) for delivery on a UNIX system, a white paper, and a technical web site. The help system was delivered using a platform independent, HTML-based technology, manpages were delivered in NROFF for the man command, and the user manual was delivered as PDF and HTML on docs.hp.com and as PDF with the product. Reused content was authored in context within the documents and reused opportunistically rather than from a central repository.

References

[1]

Ament, Kurt. Single Sourcing: Building Modular Documentation. William Andrew Publishing, 2003.

Google Scholar

[2]

http://www.bellevuelinux.org/transclusion.html, Online Document, Accessed August 2007.

Google Scholar

[3]

Johnson, Melanie M. A Case Study in Modular Documentation. In Proceedings of the STC 2000 Conference, 2000.

Google Scholar

[4]

Nelson, Ted. Literary Machines, "Xanadu," Mindful Press, Sausalito, CA, 1981

Google Scholar

[5]

Rockley, Ann. Information Modeling for Single Sourcing. In Proceedings of the 20th Annual International Conference on Documentation (SIGDOC 2002) (Toronto, Ontario, Canada, October 20-23, 2002). ACM Press, New York, NY, 2002, 177--178.

Digital Library

Google Scholar

[6]

Stock, Ingo, Michael Weber. Authoring Technical Documentation Using a Generic Document Model. In Proceedings of the 24th ACM International Conference on Design of Communication (SIGDOC 2006) (Myrtle Beach, South Carolina, USA, October 18-20, 2006). ACM Press, New York, NY, 2006, 172--179.

Digital Library

Google Scholar

[7]

DocBook transforms (http://docbook.sourceforge.net/), Online Source Repository, Accessed August 2007.

Google Scholar

[8]

Walsh, Norman and Muellner, Leonard with contributions from Stayton, Bob, DocBook: The Definitive Guide (http://www.docbook.org/tdg/en/html/docbook.html), Online Document, Accessed August 2007.

Digital Library

Google Scholar

[9]

Kimber, W. Elliot, Modular Information: Using XInclude to Support Reuse for Authoring and Publication. In Proceedings of XML Europe 2004 http://www.idealliance.org/papers/dx_xmle04/papers/03-05-01/03-05-01.html, Online Document, Accessed August 2007.

Google Scholar

Cited By

View all

Zaytsev VLämmel R(2011)A Unified Format for Language DocumentsSoftware Language Engineering10.1007/978-3-642-19440-5_13(206-225)Online publication date: 2011
https://doi.org/10.1007/978-3-642-19440-5_13
Zaytsev VLämmel R(2010)A unified format for language documentsProceedings of the Third international conference on Software language engineering10.5555/1964571.1964590(206-225)Online publication date: 12-Oct-2010
https://dl.acm.org/doi/10.5555/1964571.1964590
Haramundanis KMehlenbacher BProtopsaltis AWilliams ASlattery S(2009)Experience reportProceedings of the 27th ACM international conference on Design of communication10.1145/1621995.1622023(151-154)Online publication date: 5-Oct-2009
https://dl.acm.org/doi/10.1145/1621995.1622023

Index Terms

Experience paper: a content reuse documentation design experience

Recommendations

Authoring technical documentation using a generic document model
SIGDOC '06: Proceedings of the 24th annual ACM international conference on Design of communication

As modern technical products like cars become more and more sophisticated, there is an increasing demand for a new type of technical documentation, for the owners and in particular for repair and maintenance staff. To achieve this goal the instructions ...
Authors vs. readers: a comparative study of document metadata and content in the www
DocEng '07: Proceedings of the 2007 ACM symposium on Document engineering

Collaborative tagging describes the process by which many users add metadata in the form of unstructured keywords to shared content. The recent practical success of web services with such a tagging component like Flickr or del.icio.us has provided a ...
A System for Document Reuse
ICCSSE '96: Proceedings of the 7th Israeli Conference on Computer-Based Systems and Software Engineering

The paper is concerned with issues and methods for reusing document pieces in the process of constructing other document. Asserting that the practice of reuse deserves a central role in the process of document creation, the authors present a document ...

Comments

Information & Contributors

Information

Published In

SIGDOC '07: Proceedings of the 25th annual ACM international conference on Design of communication

October 2007

286 pages

ISBN:9781595935885

DOI:10.1145/1297144

General Chair:
David Novick
The University of Texas at El Paso, TX
,
Program Chair:
Clay Spinuzzi
The University of Texas at Austin, TX

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: 22 October 2007

Permissions

Request permissions for this article.

Request Permissions

Check for updates

Author Tags

Qualifiers

Article

Conference

SIGDOC07

Sponsor:

SIGDOC07: The 25th ACM International Conference on Design of Communication

October 22 - 24, 2007

Texas, El Paso, 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
277
Total Downloads

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

Reflects downloads up to 01 Mar 2025

Other Metrics

View Author Metrics

Citations

Cited By

View all

Zaytsev VLämmel R(2011)A Unified Format for Language DocumentsSoftware Language Engineering10.1007/978-3-642-19440-5_13(206-225)Online publication date: 2011
https://doi.org/10.1007/978-3-642-19440-5_13
Zaytsev VLämmel R(2010)A unified format for language documentsProceedings of the Third international conference on Software language engineering10.5555/1964571.1964590(206-225)Online publication date: 12-Oct-2010
https://dl.acm.org/doi/10.5555/1964571.1964590
Haramundanis KMehlenbacher BProtopsaltis AWilliams ASlattery S(2009)Experience reportProceedings of the 27th ACM international conference on Design of communication10.1145/1621995.1622023(151-154)Online publication date: 5-Oct-2009
https://dl.acm.org/doi/10.1145/1621995.1622023

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.

PDF

eReader

View online with eReader.

eReader

Abstract

References

Cited By

Index Terms

Recommendations

Authoring technical documentation using a generic document model

Authors vs. readers: a comparative study of document metadata and content in the www

A System for Document Reuse

Comments

Information

Published In

Sponsors

Publisher

Publication History

Permissions

Check for updates

Author Tags

Qualifiers

Conference

Acceptance Rates

Contributors

Other Metrics

Bibliometrics

Article Metrics

Other Metrics

Citations

Cited By

Login options

Full Access

View options

PDF

eReader

Share

Share this Publication link

Share on social media

Affiliations