Developing Quality Technical Information: A Handbook for Writers and Editors

4.38 avg rating
( 8 ratings by GoodReads )
 
9780133118971: Developing Quality Technical Information: A Handbook for Writers and Editors

Today, technical communicators have an even greater responsibility to help their organizations create easy-to-use, leading-edge products. The era of simply "papering" a product with lengthy manuals is over: now, communicators need to create self-documenting interfaces and self-correcting messages, and help product teams craft offerings that always place the user front-and-center.

 

The newest edition of IBM's classic Developing Quality Technical Information: A Handbook for Writers and Editors focuses squarely on these new realities. It introduces a new technical communications model that:

  • Involves technical communicators during the product design phase
  • Changes the way technical communicators think about their roles in developing technical content
  • Emphasizes user advocacy
  • Shows how to embrace emerging trends in product design
  • Helps writers think more and write less
  • Delivers the right content at the right time, in the most direct, clear, and minimal form possible

Drawing on IBM's unsurpassed technical communications experience, you'll discover today's best practices for meeting nine quality characteristics: accuracy, clarity, completeness, concreteness, organization, retrievability, style, task orientation, and visual effectiveness.

 

Packed with guidelines, checklists, and before-and-after examples, Developing Quality Technical Information, Third Edition is an indispensable resource for the future of technical communication.

"synopsis" may belong to another edition of this title.

Product Description:

The #1 Guide to Excellence in Technical Communication—Fully Updated for Embedded Assistance, Mobile, Search, Multimedia, and More

 

Direct from IBM’s own content design experts, this guide shows you how to design product interfaces and technical information that always place users front and center. This edition has been fully revised to help you consistently deliver the right content at the right time.

 

You’ll master today’s best practices to apply nine essential characteristics of high-quality technical information: accuracy, clarity, completeness, concreteness, organization, retrievability, style, task orientation, and visual effectiveness.

 

Coverage Includes

  • Advocating for users throughout the entire product development process
  • Delivering information in an ordered manner by following progressive disclosure techniques
  • Optimizing content so that users can find it from anywhere
  • Streamlining information for mobile delivery
  • Helping users right where they are

Whether you’re a writer, editor, information architect, user experience professional, or reviewer, this book shows you how to create great technical information, from the product design to the user interface, topics, and other media.

  • Thoroughly revised and updated
  • Extensive new coverage of self-documenting interfaces and embedded assistance
  • Updated practical guidelines and checklists
  • Hundreds of new examples

 

 

About the Author:

The authors are all long-standing and respected members of the information development community at IBM. Although the authors have served in various roles throughout their careers, information quality has always been and continues to be their primary focus.

 

Michelle Carey is an information architect and technical editor at IBM and has taught technical communication at University of California Santa Cruz Extension. Michelle is the co-author of the book DITA Best Practices: A Roadmap for Writing, Editing, and Architecting in DITA. She is an expert on topic-based information systems, software product error messages, grammar, embedded assistance for user interfaces, and writing for international audiences. She also writes computational linguistic rules for a grammar, style, and terminology management tool. Michelle enjoys teaching, grammar, herding cats, and riding and driving anything with a lot of horsepower.

 

Moira McFadden Lanyi is an information architect and technical editor at IBM. She has experience with topic-based writing, DITA, embedded assistance, user interface design, and visual design. She created 99% of the artwork in this book. She is a co-author of the book An Introduction to IMS. Moira enjoys visiting San Francisco with her family as often as possible, cooking fresh, healthy meals, and watching her courageous son ride his unicycle and surf.

 

Deirdre Longo is an information architect and strategist at IBM. She has been a pioneer for embedded assistance in IBM: defining the scope of that term, developing standards for embedded assistance, and modeling how to work effectively in cross-disciplinary teams. She has taught webinars for the Society of Technical Communication (STC) and published articles on information architecture topics in STC’s Intercom. She is an avid yoga practitioner.

 

Eric Radzinski is a technical editor and information architect for industry-leading mainframe database software at IBM. He is a co-author of The IBM Style Guide: Conventions for Writers and Editors and is well versed in topic-based writing, embedded assistance, DITA, and writing for a global audience. Eric makes his home in San Jose, California, with his wife and their three children.

 

Shannon Rouiller is an information architect and technical editor at IBM. She has experience with quality metrics, topic-based information systems, DITA, videos, embedded assistance, and user interface design. She is a co-author of the book Designing Effective Wizards. Shannon dabbles in sports photography and likes to solve puzzles.

 

Elizabeth Wilde is an information quality strategist at IBM, developing strategies and education for developing high-quality content. She develops Acrolinx computational linguistic rules that enforce grammar, style, and DITA tagging rules. She teaches an extension course in technical writing at the University of California Santa Cruz. Her hobbies include growing cacti and succulents and collecting tattoos.

 

"About this title" may belong to another edition of this title.

Top Search Results from the AbeBooks Marketplace

1.

Michelle Carey, Moira McFadden Lanyi, Deirdre Longo
Published by Pearson Education (US), United States (2014)
ISBN 10: 0133118975 ISBN 13: 9780133118971
New Paperback Quantity Available: 1
Seller
The Book Depository
(London, United Kingdom)
Rating
[?]

Book Description Pearson Education (US), United States, 2014. Paperback. Book Condition: New. 3rd Revised edition. 231 x 180 mm. Language: English . Brand New Book. The #1 Guide to Excellence in Technical Communication-Fully Updated for Embedded Assistance, Mobile, Search, Multimedia, and More Direct from IBM s own content design experts, this guide shows you how to design product interfaces and technical information that always place users front and center. This edition has been fully revised to help you consistently deliver the right content at the right time. You ll master today s best practices to apply nine essential characteristics of high-quality technical information: accuracy, clarity, completeness, concreteness, organization, retrievability, style, task orientation, and visual effectiveness. Coverage Includes * Advocating for users throughout the entire product development process * Delivering information in an ordered manner by following progressive disclosure techniques * Optimizing content so that users can find it from anywhere * Streamlining information for mobile delivery * Helping users right where they are Whether you re a writer, editor, information architect, user experience professional, or reviewer, this book shows you how to create great technical information, from the product design to the user interface, topics, and other media. * Thoroughly revised and updated * Extensive new coverage of self-documenting interfaces and embedded assistance * Updated practical guidelines and checklists * Hundreds of new examples. Bookseller Inventory # AAU9780133118971

More Information About This Seller | Ask Bookseller a Question

Buy New
25.77
Convert Currency

Add to Basket

Shipping: FREE
From United Kingdom to U.S.A.
Destination, Rates & Speeds

2.

Wilde, Elizabeth; Carey, Michelle; Longo, Deirdre; Rouiller, Shannon; Lanyi, Moira Mcfadden; Radzinski, Eric
ISBN 10: 0133118975 ISBN 13: 9780133118971
New Quantity Available: 5
Seller
GreatBookPrices
(Columbia, MD, U.S.A.)
Rating
[?]

Book Description Book Condition: New. Bookseller Inventory # 19348325-n

More Information About This Seller | Ask Bookseller a Question

Buy New
24.35
Convert Currency

Add to Basket

Shipping: 2.11
Within U.S.A.
Destination, Rates & Speeds

3.

Michelle Carey, Moira McFadden Lanyi, Deirdre Longo
Published by Pearson Education (US), United States (2014)
ISBN 10: 0133118975 ISBN 13: 9780133118971
New Paperback Quantity Available: 1
Seller
The Book Depository US
(London, United Kingdom)
Rating
[?]

Book Description Pearson Education (US), United States, 2014. Paperback. Book Condition: New. 3rd Revised edition. 231 x 180 mm. Language: English . Brand New Book. The #1 Guide to Excellence in Technical Communication-Fully Updated for Embedded Assistance, Mobile, Search, Multimedia, and More Direct from IBM s own content design experts, this guide shows you how to design product interfaces and technical information that always place users front and center. This edition has been fully revised to help you consistently deliver the right content at the right time. You ll master today s best practices to apply nine essential characteristics of high-quality technical information: accuracy, clarity, completeness, concreteness, organization, retrievability, style, task orientation, and visual effectiveness. Coverage Includes * Advocating for users throughout the entire product development process * Delivering information in an ordered manner by following progressive disclosure techniques * Optimizing content so that users can find it from anywhere * Streamlining information for mobile delivery * Helping users right where they are Whether you re a writer, editor, information architect, user experience professional, or reviewer, this book shows you how to create great technical information, from the product design to the user interface, topics, and other media. * Thoroughly revised and updated * Extensive new coverage of self-documenting interfaces and embedded assistance * Updated practical guidelines and checklists * Hundreds of new examples. Bookseller Inventory # AAU9780133118971

More Information About This Seller | Ask Bookseller a Question

Buy New
26.53
Convert Currency

Add to Basket

Shipping: FREE
From United Kingdom to U.S.A.
Destination, Rates & Speeds

4.

Michelle Carey, Moira McFadden Lanyi, Deirdre Longo, Eric Radzinski, Shannon Rouiller
Published by Pearson Education (US)
ISBN 10: 0133118975 ISBN 13: 9780133118971
New Paperback Quantity Available: 6
Seller
THE SAINT BOOKSTORE
(Southport, United Kingdom)
Rating
[?]

Book Description Pearson Education (US). Paperback. Book Condition: new. BRAND NEW, Developing Quality Technical Information: A Handbook for Writers and Editors (3rd Revised edition), Michelle Carey, Moira McFadden Lanyi, Deirdre Longo, Eric Radzinski, Shannon Rouiller, The #1 Guide to Excellence in Technical Communication-Fully Updated for Embedded Assistance, Mobile, Search, Multimedia, and More Direct from IBM's own content design experts, this guide shows you how to design product interfaces and technical information that always place users front and center. This edition has been fully revised to help you consistently deliver the right content at the right time. You'll master today's best practices to apply nine essential characteristics of high-quality technical information: accuracy, clarity, completeness, concreteness, organization, retrievability, style, task orientation, and visual effectiveness. Coverage Includes * Advocating for users throughout the entire product development process * Delivering information in an ordered manner by following progressive disclosure techniques * Optimizing content so that users can find it from anywhere * Streamlining information for mobile delivery * Helping users right where they are Whether you're a writer, editor, information architect, user experience professional, or reviewer, this book shows you how to create great technical information, from the product design to the user interface, topics, and other media. * Thoroughly revised and updated * Extensive new coverage of self-documenting interfaces and embedded assistance * Updated practical guidelines and checklists * Hundreds of new examples. Bookseller Inventory # B9780133118971

More Information About This Seller | Ask Bookseller a Question

Buy New
22.32
Convert Currency

Add to Basket

Shipping: 5.94
From United Kingdom to U.S.A.
Destination, Rates & Speeds

5.

Michelle Carey, Moira McFadden Lanyi, Deirdre Longo
Published by Pearson Education (US) 2014-06-25, Armonk (2014)
ISBN 10: 0133118975 ISBN 13: 9780133118971
New paperback Quantity Available: 5
Seller
Blackwell's
(Oxford, OX, United Kingdom)
Rating
[?]

Book Description Pearson Education (US) 2014-06-25, Armonk, 2014. paperback. Book Condition: New. Bookseller Inventory # 9780133118971

More Information About This Seller | Ask Bookseller a Question

Buy New
24.51
Convert Currency

Add to Basket

Shipping: 4.50
From United Kingdom to U.S.A.
Destination, Rates & Speeds

6.

Carey, Michelle; Lanyi, Moira McFadden; Longo, Deirdre; Radzinski, Eric; Rouiller, Shannon; Wilde, Elizabeth
ISBN 10: 0133118975 ISBN 13: 9780133118971
New Quantity Available: 6
Seller
BWB
(Valley Stream, NY, U.S.A.)
Rating
[?]

Book Description Book Condition: New. Depending on your location, this item may ship from the US or UK. Bookseller Inventory # 97801331189710000000

More Information About This Seller | Ask Bookseller a Question

Buy New
31.16
Convert Currency

Add to Basket

Shipping: FREE
Within U.S.A.
Destination, Rates & Speeds

7.

Michelle Carey
Published by Pearson Education (2014)
ISBN 10: 0133118975 ISBN 13: 9780133118971
New Quantity Available: 6
Seller
Books2Anywhere
(Fairford, GLOS, United Kingdom)
Rating
[?]

Book Description Pearson Education, 2014. PAP. Book Condition: New. New Book. Shipped from UK in 4 to 14 days. Established seller since 2000. Bookseller Inventory # BB-9780133118971

More Information About This Seller | Ask Bookseller a Question

Buy New
23.29
Convert Currency

Add to Basket

Shipping: 9
From United Kingdom to U.S.A.
Destination, Rates & Speeds

8.

Carey, MichelleLanyi, Moira McFaddenLongo, DeirdreRadzinski, EricRouiller, Shannon<B
Published by Prentice Hall
ISBN 10: 0133118975 ISBN 13: 9780133118971
New Quantity Available: > 20
Seller
INDOO
(Avenel, NJ, U.S.A.)
Rating
[?]

Book Description Prentice Hall. Book Condition: New. Brand New. Bookseller Inventory # 0133118975

More Information About This Seller | Ask Bookseller a Question

Buy New
31.67
Convert Currency

Add to Basket

Shipping: 2.80
Within U.S.A.
Destination, Rates & Speeds

9.

Hargis, Gretchen; Carey, Michelle; Hernandez, Ann
Published by Prentice Hall (2014)
ISBN 10: 0133118975 ISBN 13: 9780133118971
New Softcover Quantity Available: 1
Seller
Rating
[?]

Book Description Prentice Hall, 2014. Book Condition: New. Bookseller Inventory # EH9780133118971

More Information About This Seller | Ask Bookseller a Question

Buy New
30.53
Convert Currency

Add to Basket

Shipping: 5.20
From Germany to U.S.A.
Destination, Rates & Speeds

10.

Carey, Michelle/ Lanyi, Moira Mcfadden/ Longo, Deirdre/ Radzinski, Eric/ Rouiller, Shannon
Published by IBM Pr (2014)
ISBN 10: 0133118975 ISBN 13: 9780133118971
New Paperback Quantity Available: 2
Seller
Revaluation Books
(Exeter, United Kingdom)
Rating
[?]

Book Description IBM Pr, 2014. Paperback. Book Condition: Brand New. 3rd edition. 500 pages. 7.25x9.25x1.25 inches. In Stock. Bookseller Inventory # __0133118975

More Information About This Seller | Ask Bookseller a Question

Buy New
33.20
Convert Currency

Add to Basket

Shipping: 6
From United Kingdom to U.S.A.
Destination, Rates & Speeds

There are more copies of this book

View all search results for this book