Reference Checklist
|
|
|
Home Page
iChat
|
Choosing the Right Form of Reference Have you chosen the right form of reference to match your users’ needs? q Reference section (tables of dates, definitions, command descriptions) q Quick reference (card, booklet, brochure) q Appendix (tables, messages, troubleshooting) q Update information/ ReadMe files (disk file containing update highlights) q Job aids (reminders, command lists) q Innovative forms: flipcards Deciding What to Include in the Reference Section Which of the following elements meet your users’ needs? q Commands q Interface elements q Definitions q Concepts q Relationships among commands q How-to information q Technical information Deciding What to Include in Each Reference Entry Identify which of the following elements you want or need to include in each reference entry to meet your users’ support needs. q Definition: Tell what the command or function does. q Explanation: Tell how to apply the command or function. q Example/syntax: Give an example of the command or function in use. q Step-by-step: Present abbreviated steps for using the command or function. q Warnings/cautions: Let the user know what problems might arise. Establishing a Pattern q Have you established a pattern for each reference entry? Organizing the Reference Section Which of the following organizational patterns do you intend to use? q Alphabetical q Menu by menu Showing the User How to Use the Reference Information Have you written a section that tells the user the following things? q Who should use the information q How you organized the information q The elements of each entry q Cross-references q Sample library entry |
|
