Discusses documenting object-oriented projects from the technical writer's perspective. Suggests that writers prepare themselves by becoming educated, getting comfortable with object-oriented concepts, understanding reuse, defining a development process with the rest of the project team, and defining document requirements using rapid prototyping.…

Reviews typical software testing activities and then compares those activities to technical editing activities. Shows that by providing quality assurance through content editing, technical editors add value to the information development process and help give users the quality content they deserve. Concludes that product information must go…

Guidelines for writing documentation for automated library systems cover (1) gathering information; (2) planning the document (manual types, organization patterns, writing style, conventions and standards, and format); (3) writing techniques; (4) deciding what to include; and (5) editing and testing. (three references) (MES)

Outlines the process of planning and developing a multimedia documentation project. Discusses audience, task, and information analysis; selection of the most appropriate media; effective design; establishment of the development team; hardware and software requirements; costs; and project planning. (SR)

Argues that technical communicators should have a working definition of icons, know when to use them, and understand some of the problems inherent in icon design. Recommends using a workable icon classification system and adhering to some practical design guidelines. (SR)

Presents a 10-step procedure for selecting the computer software needed to author and deliver online documentation. (SR)

The first of two articles addressing the issue of user documentation for computer software discusses the need to teach users how to read documentation. The second presents a guide for writing documentation that is based on the instructional systems design model, and makes suggestions for the desktop publishing of user manuals. (CLB)

Discusses the advantages and disadvantages of prepackaged software programs and custom-developed software programs, along with the use of microcomputers. (MD)

Offers guidelines for evaluating library system vendor documentation using the following criteria: physical appearance, audience, orientation, structure, consistency, accuracy, completeness, readability, and usability. Several examples illustrate alternative ways to present information. (two references) (MES)

Describes why developers of multimedia products face a more complex legal landscape than do developers of "few-media" products. Describes the laws that pertain to multimedia. Discusses how developers of multimedia products might walk the legal labyrinth and protect themselves and their companies from lawsuits. (SR)

Discusses how to choose the medium or media to communicate technical information, how to combine and integrate media, and what the user can use. (SR)

Argues that online help systems are often not helpful and even increase the user's frustration and stress level. States that an instructional design perspective can increase the effectiveness of online help systems, and offers a checklist. Examines the instructional components of the checklist and identifies ways they could be added to an online…

Explains format, style rules, and lexicographic conventions that improve clarity and precision in a technical glossary. Discusses general rules, rules of style, rules of grammar and syntax, and rules for figures. Describes the computer display techniques and file management system used to develop such a glossary. (SR)

This document describes the processes involved in writing an effective user manual intended to give the reader a working knowledge of a computer program named FUND-RAISER. Written in UCSD PASCAL, FUND-RAISER was developed by the Winter Park Library Association to ease the record keeping and letter writing tasks involved in the association's annual…

Discusses what usability is and how to test for it. Offers nine suggestions for technical communicators working on usability testing. (SR)