How To Write Usable User Documentation PDF Download

Author: Edmond H. Weiss
Publisher: Greenwood
ISBN:
Category : Business & Economics
Languages : en
Pages : 290

View

Book Description
This popular handbook presents a step-by-step method for clearly explaining a product, system, or procedure. The easy-to-follow text--packed with examples and illustrations--explains the unique demands of this form of writing and shows how to set up the best user model. The book covers developing a modular outline and storyboard, generating the draft, revising, developing a formal usability test, and supporting and updating user documentation. Also included are a glossary of terms, a listing of books and periodicals for additional information, and an index.

Author: R. John Brockmann
Publisher: New York : Wiley & Sons
ISBN:
Category : Computers
Languages : en
Pages : 394

View

Book Description
Designed to help processing professionals and technical writers write clear, accurate computer user documentation. Presents a systematic approach to writing paper and online documentation. Version 2 retains much essential material from the first edition, while offering new information on desktop publishing, CASE tools and the ``software factory'' programming technologies. Also covers new techniques such as team writing, hypertext, mass storage and more.

Author: Anne Gentle
Publisher: Lulu.com
ISBN: 1387081322
Category : Computers
Languages : en
Pages : 118

View

Book Description
Looking for a way to invigorate your technical writing team and grow that expertise to include developers, designers, and writers of all backgrounds? When you treat docs like code, you multiply everyone's efforts and streamline processes through collaboration, automation, and innovation. Second edition now available with updates and more information about version control for documents and continuous publishing.

Author: Stephen Doheny-Farina
Publisher: MIT Press
ISBN: 9780262040983
Category : Computers
Languages : en
Pages : 376

View

Book Description
"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.

Author: Katherine Haramundanis
Publisher: Digital Press
ISBN: 1483184013
Category : Computers
Languages : en
Pages : 287

View

Book Description
The Art of Technical Documentation presents concepts, techniques, and practices in order to produce effective technical documentation. The book provides the definition of technical documentation; qualities of a good technical documentation; career paths and documentation management styles; precepts of technical documentation; practices for gathering information, understanding what you have gathered, and methods for testing documentation; and considerations of information representation, to provide insights on how different representations affect reader perception of your documents. Technical writers and scientists will find the book a good reference material.

Author: Microsoft Corporation
Publisher: Pearson Education
ISBN: 0735669791
Category : Computers
Languages : en
Pages : 823

View

Book Description
Maximize the impact and precision of your message! Now in its fourth edition, the Microsoft Manual of Style provides essential guidance to content creators, journalists, technical writers, editors, and everyone else who writes about computer technology. Direct from the Editorial Style Board at Microsoft—you get a comprehensive glossary of both general technology terms and those specific to Microsoft; clear, concise usage and style guidelines with helpful examples and alternatives; guidance on grammar, tone, and voice; and best practices for writing content for the web, optimizing for accessibility, and communicating to a worldwide audience. Fully updated and optimized for ease of use, the Microsoft Manual of Style is designed to help you communicate clearly, consistently, and accurately about technical topics—across a range of audiences and media.

Author: Michael Bremer
Publisher:
ISBN:
Category : Language Arts & Disciplines
Languages : en
Pages : 238

View

Book Description
No other book can better prepare you to work as a writer in the technical world, to write better about technology for a nontechnical audience, or to understand how the ever-more-inportant writer can help fill the technology gap between the knows and know-nots. Book jacket.

Author: Kurt Guntheroth
Publisher: "O'Reilly Media, Inc."
ISBN: 1491922036
Category : Computers
Languages : en
Pages : 387

View

Book Description
In today’s fast and competitive world, a program’s performance is just as important to customers as the features it provides. This practical guide teaches developers performance-tuning principles that enable optimization in C++. You’ll learn how to make code that already embodies best practices of C++ design run faster and consume fewer resources on any computer—whether it’s a watch, phone, workstation, supercomputer, or globe-spanning network of servers. Author Kurt Guntheroth provides several running examples that demonstrate how to apply these principles incrementally to improve existing code so it meets customer requirements for responsiveness and throughput. The advice in this book will prove itself the first time you hear a colleague exclaim, “Wow, that was fast. Who fixed something?” Locate performance hot spots using the profiler and software timers Learn to perform repeatable experiments to measure performance of code changes Optimize use of dynamically allocated variables Improve performance of hot loops and functions Speed up string handling functions Recognize efficient algorithms and optimization patterns Learn the strengths—and weaknesses—of C++ container classes View searching and sorting through an optimizer’s eye Make efficient use of C++ streaming I/O functions Use C++ thread-based concurrency features effectively

Author: Charles H. Sides
Publisher: Bloomsbury Publishing USA
ISBN: 1440855064
Category : Technology & Engineering
Languages : en
Pages : 256

View

Book Description
Thoroughly updated to discuss the use of tools such as Skype and social media, this concise volume shows how effective communication—via written text and spoken presentations—can positively impact project management in professional environments. Professional communications are the "information product" of all organizations and businesses. Based on that premise, this book offers communications strategies that will benefit any organization that disseminates technical information in-house and/or to customers. The popular work provides easy-to-understand and apply guidelines for designing and writing effective technical documents, as well as other related communications. What makes this new edition especially valuable is that it maintains the quality of information that distinguished the previous editions, but is now updated to encompass current technology and trends, including today's prevalent communication tools such as social media. The book begins by looking at skills common to all technical writing and offering general advice on designing and writing reports. Next is a discussion of specific types of reports along with common problems and issues writers face. Finally, the work overviews other forms of communications such as professional presentations. The updated material also considers the growing importance of interviews and focus groups as information-gathering tools, the influence of visual rhetoric, and the use of technologies such as Skype and webinars.

Author: Edmond H. Weiss
Publisher: Philadelphia : ISI Press
ISBN:
Category : Computers
Languages : en
Pages : 224

View

Book Description