A directory of resources inthe field of technical communication.

Barten, Alfred


About this Site | Advanced Search | Localization | Site Maps

 

1.
#27112

Cataloging Information Aids Help Development

Context-sensitive help systems often need redundant placement of information. This ensures that the information is seen by visitors who enter and move unpredictably through the system. Redundant placements take the form of descriptions, explanations, warnings, and the like that amplify other subjects. In software documentation, for example, some candidate subjects include the purposes of screens and tabs, the effects of selected options and significant functions such as Delete, and reminders of required access permissions and prerequisite steps or conditions. You can save development time and promote consistency by cataloging information so that it can be inserted wherever needed using your authoring software's copy and paste functions.

Barten, Alfred. Boston Broadside (2001). Articles>Documentation>Indexing