Best Practices for Technical Writers and Editors, Video Enhanced Edition (Collection): DITA, Quality, and Style

Front Cover
Pearson Education, Apr 13, 2012 - Technology & Engineering - 1188 pages
0 Reviews
Normal 0 false false false MicrosoftInternetExplorer4

A brand new collection of state-of-the-art insights for technical writers, editors, and content managers…in a convenient e-format, at a great price!


Three outstanding IBM Press eBooks plus exclusive video walkthroughs help you maximize the value and effectiveness of your technical communications—in all media, for all audiences, everywhere! (Enhanced eBook)


This package brings together unsurpassed IBM eBook and video resources for creating clearer, more usable, more effective technical communication. For one low price, you get three outstanding IBM Press books in industry-standard ePub format, plus exclusive video demonstrations walking through many key topics and techniques on DITA, step-by-step! The IBM Style Guide: Conventions for Writers and Editors distills IBM’s best wisdom for developing higher-quality content across all media, authors, and geographic locations. It delivers up-to-the minute guidance on topic-based writing; writing for diverse media and global audiences; organizing, structuring, and linking information; maximizing accessibility; documenting interfaces and procedures; and much more. Next, in DITA Best Practices: A Roadmap for Writing, Editing, and Architecting in DITA , three pioneering implementers show how to use DITA to maximize the value of technical documentation, and offer a complete roadmap for successful DITA adoption and usage. The authors answer crucial questions “official” DITA documents ignore, including: “Where do you start?” and “How do you avoid the pitfalls?” Discover proven best practices for developing effective topics, short descriptions, and content architecture, plus “in-the-trenches” solutions for ensuring quality implementations and accurate, cost-effective content conversion, including video demonstrations. Finally, Developing Quality Technical Information: A Handbook for Writers and Editors , Second Edition, presents today’s most systematic, well-proven approach to creating great documentation. Learn how to focus on the right tasks and topics; say more with fewer words; use organization to deliver faster access; streamline and improve reviews; and much more. Packed with before-and-after examples, illustrations, and checklists, this book addresses crucial topics ranging from internationalization to retrievability to visual effectiveness. Whether you’re a writer, editor, reviewer, or manager, if you want to create outstanding content, you’ll find this collection absolutely indispensable.


From expert IBM and IBM Press publication professionals Francis DeRespinis, Peter Hayward, Jana Jenkins, Amy Laird, Leslie McDonald, Eric Radzinski, Laura Bellamy, Michelle Carey, Jenifer Schlotfeldt, Gretchen Hargis, Ann Kilty Hernandez, Polly Hughes, Deirdre Longo, Shannon Rouiller, and Elizabeth Wilde.


Important note: Due to the incredibly rich media included in your enhanced eBook, you may experience longer than usual download times. Please be patient while your product is delivered.


 

What people are saying - Write a review

We haven't found any reviews in the usual places.

Contents

The IBMStyle Guide
Language and grammar
Messages
Writing for diverse audiences
Appendixes
Index
DITA Best Practices
Video Demonstrations
Metadata
Conditional Processing
Writers CanReuse Topics
Reusing Topics
Reusing ContentfromNonDITA Sources
Converting and Editing
Applying more than one quality characteristic
Revising technical information 12 Reviewing testingand evaluating technical information

Introduction
Submaps
Short Descriptions ProvideUnique ShortDescriptions for Reused Topics
Linking

Common terms and phrases

About the author (2012)

Normal 0 false false false MicrosoftInternetExplorer4

Francis DeRespinis, Peter Hayward, Jana Jenkins, Amy Laird, Leslie McDonald, and Eric Radzinski are members of the IBM Style and Word Usage Council, a workgroup of senior editors who represent key product brands in IBM. Laura Bellamy, Information Architect at VMware, Inc., and technical communications instructor at UC Santa Cruz Extension, worked at IBM during its pioneering DITA adoption. Michelle Carey, IBM technical editor and UC Santa Cruz Extension technical communications instructor, has taught best practices for content development and DITA authoring to teams throughout IBM. Jenifer Schlotfeldt,IBMtechnical writer and UC Santa Cruz Extension technical communications instructor, has authored, tested, and taught DITA at IBM since 2003, and also contributed to new DITA specializations. Gretchen Hargis (1944-2005) was a member of the STL Editing Council at IBM's Santa Teresa Laboratory in San Jose, CA, an IBM organization dedicated to excellence in technical information. Ann Kilty Hernandez has been an IBM technical writer, manager, and marketing specialist, and coauthored An Introduction to DB2 for OS/390. Polly Hughes, now retired from IBM, worked as a visual designer for technical information and software interfaces, and as a technical writer. Deirdre Longo, IBM technical editor and writer, edits product interfaces and writes customer information, primarily for content management products. Shannon Rouiller, IBM technical editor, has written and edited topic-based information systems, contextual help, wizards, and product interfaces. She coauthored Designing Effective Wizards. Elizabeth Wilde, IBM technical editor, is a leader in developing quality metrics and processes for technical documentation, and educating writers throughout IBM on developing user-centered information.

Bibliographic information