Chris Hallgren
ABSTRACT
This paper discusses documentation from the vantage point of language. Documentation has several different uses and many different audiences. One method of specifying the systems documentation that must accompany system installation is to involve the users of the documentation in defining the documentation standards. This was done at Simpson-Sears in Canada, and nine different types of documentation groupings were identified, by audience and by use. Some verbal gymnastics were also performed.
Index Terms
- The bit bytes the word
Recommendations
Patterns of Knowledge in API Reference Documentation
Reading reference documentation is an important part of programming with application programming interfaces (APIs). Reference documentation complements the API by providing information not obvious from the API syntax. To improve the quality of reference ...
Using offline documentation online
Current interactive programs usually provide some form of online documentation in addition to the traditional hard-copy user's manual. To save the expense of writing two documents covering the same material, it is not uncommon to find offline manuals ...
Printed pages vs. web pages: the documentation dilemma
SIGUCCS '01: Proceedings of the 29th annual ACM SIGUCCS conference on User servicesThis paper, which may interest any professional staff members who work with documentation and/or web development and design, or who offer help desk support, will discuss the advantages and disadvantages of both paper and on-line documentation. It will ...
Comments