Writing for adaptable documentation

Authors:
Erik Berglund
Affiliations:
Linköping University, Sweden
Venue:
IPCC/SIGDOC '00 Proceedings of IEEE professional communication society international professional communication conference and Proceedings of the 18th annual ACM international conference on Computer documentation: technology & teamwork
Year:
2000

Citing 12
Cited 2

Designing documentation to compensate for delocalized plans

Communications of the ACM
The adaptable user interface

Communications of the ACM
Literate programming

Literate programming
Bugs in writing, a guide to debugging your prose

Bugs in writing, a guide to debugging your prose
Online documentation: the next generation

SIGDOC '97 Proceedings of the 15th annual international conference on Computer documentation
A framework for generating adaptable hypermedia documents

MULTIMEDIA '97 Proceedings of the fifth ACM international conference on Multimedia
Documentu: a flexible architecture for documentation production based on a reverse-engineering strategy

Journal of Software Maintenance: Research and Practice
API documentation from source code comments: a case study of Javadoc

SIGDOC '99 Proceedings of the 17th annual international conference on Computer documentation
The Mathematica book (4th edition)

The Mathematica book (4th edition)
ActiveText: a method for creating dynamic and interactive texts

Proceedings of the 12th annual ACM symposium on User interface software and technology
The Java Tutorial, Second Edition: Object-Oriented Programming for the Internet (Book/CD)

The Java Tutorial, Second Edition: Object-Oriented Programming for the Internet (Book/CD)
Adaptive Hypermedia

User Modeling and User-Adapted Interaction

The relevance of software documentation, tools and technologies: a survey

Proceedings of the 2002 ACM symposium on Document engineering
Designing electronic reference documentation for software component libraries

Journal of Systems and Software

Quantified Score

Hi-index	0.00

Visualization

Abstract

The rapid development of reusable software components results in an information-overload problem in the development process. Software developers must read large amounts of documentation. Adaptive documentation is one way to address this problem and support efficient reading. However, in our view, adaptive documentation requires a writing process that delivers the pedagogical strategies for adaptivity. In this paper, we take stance in a project on adaptive software reference documentation and discuss the requirements on writing. We also discuss writing trends and Web languages in relation to adaptivity. We conclude that describing change in documentation is not supported on an authoring level but rather on a programming level.