Twenty-five years ago, how many people were thinking about the internet on a daily basis? Now you can find everything, including technical and instruction manuals, online. But some things never change. Users still need instructions and warnings to guide them in the safe and proper use of products. Good design, clear instructions and warnings, place
A survival guide for writers in the real-world, Writing and Designing Manuals, Third Edition has become a standard reference for technical writers and editors. Readable and practical, it addresses all aspects of manual development from choosing a format to writing effective warnings. Not limited to text elements, the manual also provides guidance for designing illustrations to complement the text and underscore the safety warnings. The completely revised and updated Third Edition includes: Þ Current materials on desktop publishing Þ Alternative media such as videos, CD-ROMs, and on-line help Þ The impact of new technology such as CD-ROMs and digital cameras on manual design and production Þ New regulations for products sold overseas Þ Impact of the Internet on manual design Gone are the days when a manual might be a few pages of typewritten text. Thanks to the advances in computer technology, even tiny companies can produce slick, professional publications. Writing and Designing Manuals, Third Edition guides you through the messy, complex, frustrating, and fascinating business of producing manuals.
Technology is changing the way we do business, the way we communicate with each other, and the way we learn. This new edition is intended to help technical writers, graphic artists, engineers, and others who are charged with producing product documentation in the rapidly changing technological world. While preserving the basic guidelines for developing manuals and warnings presented in the previous edition, this new edition offers new material as well, including a much-expanded section on hazard analysis. Features Provides more explicit guidance on conducting a hazard analysis, including methods and documentation Offers in-depth discussion of digital platforms, including video, animations, and even virtual reality, to provide users with operating instructions and safety information Incorporates current research into effective cross-cultural communication—essential in today’s global economy Explains new US and international standards for warning labels and product instructions Presents expanded material on user analysis, including addressing generational differences in experience and preferred learning styles Writing and Designing Manuals and Warnings, Fifth Edition explores how emerging technologies are changing the world of product documentation from videos to virtual reality and all points in between.
An updated edition of the classic guide to technical communication Consider that 20 to 50 percent of a technology professional's time is spent communicating with others. Whether writing a memo, preparing a set of procedures, or making an oral presentation, effective communication is vital to your professional success. This anthology delivers concrete advice from the foremost experts on how to communicate more effectively in the workplace. The revised and expanded second edition of this popular book completely updates the original, providing authoritative guidance on communicating via modern technology in the contemporary work environment. Two new sections on global communication and the Internet address communicating effectively in the context of increased e-mail and web usage. As in the original, David Beer's Second Edition discusses a variety of approaches, such as: * Writing technical documents that are clear and effective * Giving oral presentations more confidently * Using graphics and other visual aids judiciously * Holding productive meetings * Becoming an effective listener The new edition also includes updated articles on working with others to get results and on giving directions that work. Each article is aimed specifically at the needs of engineers and others in the technology professions, and is written by a practicing engineer or a technical communicator. Technical engineers, IEEE society members, and technical writing teachers will find this updated edition of David Beer's classic Writing and Speaking in the Technology Professions an invaluable guide to successful communication.
How should a technical writer analyze user needs? What types of photos and drawings work best in technical publications? How do you avoid ambiguous wording in safety warnings? "If you want to find out the best way to sew on pockets, don't ask the president of the shirt company. Ask the person working on the line, someone who has sewn on 10,000 pockets." This opening statement of the preface to Writing and Designing Manuals, 2nd Edition reflects the overall tone and philosophy of this practical, "how-to" guide to technical publication writing and design. Based on the authors' experience as teachers and consultants with technical writers, the book follows new trends and incorporates new materials on desktop publishing, techniques for visuals, safety and product liability, and production of translated materials for international markets. There are also many new sample manual pages from manuals provided by product manufacturers. The decisions writers must make when producing a manual are presented, as well as techniques for organizing office structures and writing teams to make the manual production process run as smoothly as possible. The language in the book is clear, direct, and unacademic, and the principles featured in the book can be applied to writing manuals for a variety of products, including household, automotive, chemical, industrial, mechanical, recreational, and biomedical. Discover how to analyze user needs, determine which photos and drawings will work best with publications, and design clear, effective safety warnings. Anyone faced with the task of preparing user documentation, service manuals, and other technical publications must have this book. Managers in charge of hiring technical writers or developing technical writing departments will find the book invaluable.
"Best Collection of Essays", NCTE Awards for Excellence in Technical and Scientific Communication. Effective Documentation is a major sourcebook that offers technical writers, editors, teachers, and students of technical communication a wide variety of practical guidelines based on often hard to find research in the usability of printed and electronic media. The book's eighteen chapters provide a wealth of material on such topics of current interest as the writing of design manuals, research in cognitive psychology as applied to the design of user manuals, and the organizing of manuals for hierarchical software systems. Included are chapters by such well known scholars in the field as Philip Rubens, Robert Krull, Judith Ramey, and John Carroll. Effective Documentation reviews the advice offered by other "how to produce usable documentation" books, describing the different types of usability research and explaining the inherent biases of each type. It goes beyond the actual design of textual and/or electronic media to look at these designs in context, giving advice on effective management ("good management is a requisite of good writing"), on the relationship between document design and product design, and on how to find out who one's readers really are. Advances in the presentation of textual information are explained, with suggestions on how to improve the usability of individual sentences and the design of entire books. The concluding chapters discuss advances in the design and use of online information and offer valuable insights into the use of graphic information and the development and design of information communicated via electronic media. Stephen Doheny Farina is Assistant Professor of Technical Communication at Clarkson University. Effective Documentationis included in the Information Systems series, edited by Michael Lesk.
Human Factors in System Design, Development, and Testing describes engineering system design as a behavioral process, a process which raises questions the designer must answer. It focuses on the concepts underlying the design process, culminating in a behavioral theory of the design process. Special effort has been made to depict human facto
