The Digital Technical Documentation Handbook

"The Digital Technical Documentation Handbook," published by Digital Press in 1993, serves as a comprehensive guide for creating effective technical user information within Digital Equipment Corporation. It is intended for Digital's technical publications community, third-party partners, customers, and academic institutions studying technical communication.

The handbook is structured into four main parts, along with a glossary and index:

1. Environment: This section outlines the goals of user information (accuracy, appropriateness, accessibility, clarity, completeness) and defines the roles within the user information team (writers, editors, graphic designers, production specialists, project leaders, and translation coordinators). It also details the broader product team and discusses the evolving landscape of technical communication, emphasizing modular design, multi-platform considerations, new deliverables (like online books and help), and advancements in information delivery, such as CD-ROMs and early hypermedia concepts.

2. Process: This part details the iterative information creation process, from initial research to final delivery and closure:

   • Research: Covers analyzing the audience and product, gathering information from various sources (planning documents, technical experts, user feedback), and special considerations for submitting to standards organizations.
   • Design: Focuses on designing the user information set, introducing modular information, identifying information types (conceptual, task-oriented, reference), and developing an information architecture, illustrated with a case study.
   • Information Plan: Provides guidelines for creating a detailed information plan, including project scope, content, staffing, scheduling, budgeting, and production/packaging specifics.
   • Draft and Review: Describes the iterative drafting process and various review methods (informal, formal, peer, document inspections), how to prepare for reviews, what reviewers look for, incorporating comments, and the final signoff. It also covers special considerations for field test and online information reviews.
   • Production and Distribution: Outlines the steps for preparing and submitting hardcopy and electronic files for manufacturing, including film master proofs and CD-ROM distribution.
   • Project Closure: Details post-project reviews, client satisfaction surveys, managing reader feedback, and archiving project materials.

3. Techniques: This section offers practical advice and methods for improving user information:

   • Managing Terminology: Guidance on maintaining consistent terminology, addressing translation issues, and developing style sheets, word lists, and glossaries.
   • Indexing: Principles for creating effective indexes, including primary and secondary entries, cross-references, and master indexes.
   • Online Information: Covers different types of online help systems (DECwindows XUI/Motif, OpenVMS, UNIX manpages) and online books (Bookreader).
   • Using Navigational Cues: Explores structural cues (tables of contents, indexes, road maps) and design cues (typefaces, emphasis, icons) to enhance information accessibility.
   • Usability Studies: Describes various methods for testing user information, such as questionnaires, telephone interviews, usability edits, summary tests, and contextual inquiry, with a focus on planning and conducting these studies.
   • Conducting Trademark Searches: Provides guidance on identifying and correctly using trademarks.

4. Appendixes: Includes quality assurance checklists for various stages of the information development process and a bibliography of external resources for technical communicators.

In essence, the handbook serves as a comprehensive procedural and best-practice guide for technical documentation professionals at Digital, covering everything from planning and creation to review, production, and long-term maintenance, with a strong emphasis on user-centered design and adaptability to evolving technology.