Digital Technical Documentation Handbook (eBook)

Front Cover 1
The Digital Technical Documentation Handbook 4
Copyright Page 5
Table of Contents 6
Preface 10
Part I: Environment 14
Chapter 1. User Information Environment 16
1.1 Goal of User Information 17
1.2 User Information Team 18
1.3 Product Team 23
1.4 Changing Environment 23
Part II: Process 30
Chapter 2. Overview of the Information Creation Process 32
Chapter 3. Researching the Project 34
3.1 Analyzing the Audience 34
3.2 Analyzing the Product 37
3.3 Gathering Information About the Audience and Product 38
3.4 Special Considerations: Submitting to a Standards Organization or Consortium 46
Chapter 4. Designing the User Information Set 48
4.1 What Is Modular Information? 49
4.2 Identifying Modules 50
4.3 Identifying Information Types 51
4.4 Information Architecture 52
4.5 Relationship Between Methodology, Design, and Architecture 54
4.6 Design Case Study: DECproduct 56
Chapter 5. Developing the Information Plan 74
5.1 Purpose of the Information Plan 75
5.2 Master Plans and Component Plans 75
5.3 Who Writes the Information Plan? 75
5.4 When to Write the Information Plan 76
5.5 Before Writing the Plan: Scheduling, Staffing, and Budgeting 78
5.6 Information Plan Contents 83
5.7 Product and Packaging Plans 106
Chapter 6. Draft and Review Process 112
6.1 Steps in the Draft and Review Process 113
6.2 Facing the Blank Screen 114
6.3 Informal Reviews 116
6.4 Formal Reviews 117
6.5 Preparing for Formal Review 117
6.6 What Reviewers Look For 122
6.7 Additional Review Methods 128
6.8 Incorporating Review Comments 135
6.9 Field Test Review 136
6.10 Online Information Review 139
6.11 Final Signoff 142
Chapter 7. Production and Distribution 146
7.1 Submitting Hardcopy Reproduction Packages to Internal or External Suppliers 147
7.2 Submitting Electronic Files 150
7.3 Reviewing Film Master Proofs 151
7.4 Submitting Electronic Bookreader Files for Distribution on CD-ROM 151
7.5 Duplication, Printing, and Distribution Services 152
Chapter 8. Project Closure 154
8.1 Post-Project Review 154
8.2 Client Satisfaction Survey 158
8.3 Reader Comment Cards and Other Feedback 160
8.4 Archiving 162
Part III: Techniques 164
Chapter 9. Managing Terminology 166
9.1 General Principles for Managing Terminology 167
9.2 Translation and Terminology 168
9.3 Developing Style Sheets and Word Lists 169
9.4 Developing Glossaries 171
Chapter 10. Indexing 178
10.1 Characteristics of a Good Index 178
10.2 Parts of an Index Entry 179
10.3 Steps in the Indexing Process 180
10.4 Master Indexes 202
10.5 Editing an Index 204
Chapter 11. Online Information 206
11.1 Online Books 207
11.2 Online Help 211
11.3 Hypermedia 219
Chapter 12. Using Navigational Cues 222
12.1 Structural Cues 222
12.2 Design Cues 225
Chapter 13. Overview of Usability Studies 228
13.1 Deciding What to Test 229
13.2 Writing a Testing Plan 230
13.3 Working with Participants 231
13.4 General Process for Conducting Usability Studies 236
13.5 Questionnaires 237
13.6 Structured Telephone Interviews 240
13.7 Formal and Informal Usability Edits 243
13.8 Summary Tests 245
13.9 Read and Locate Tests 246
13.10 Contextual Inquiry 249
13.11 Other Usability Study Methods 251
13.12 Summary: Selecting a Usability Method 252
Chapter 14. Conducting Trademark Searches 256
Part IV: Appendixes 258
A: 
260 
A.1 Researching Checklist 261
A.2 Information Plan Checklist 264
A.3 Online Book Checklist 266
A.4 Questionnaire Checklist 269
A.5 Telephone Interview Checklist 271
A.6 Reproduction Package Checklist 272
B: Publications Bookshelf 278
B.1 Standard Reference Works 278
B.2 Writing and Style 279
B.3 Computer Dictionaries and Glossaries 281
B.4 Multiplatform Information 281
B.5 Internationalization 282
B.6 Indexing 282
B.7 Editing 282
B.8 Usability 282
B.9 Online Information 284
B.10 Production and Manufacturing 285
B.11 Industry Standards 285
B.12 Engineering Process 285
Glossary 286
List of Trademarks 304
Index 306