Michelle Carey

Elizabeth Wilde

Eric Radzinski

Moira McFadden Lanyi

Deirdre Longo

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

A Handbook for Writers and Editors

Developing Quality Technical Information

Peter Hayward

Francis DeRespinis

Jana Jenkins

Amy Laird

Leslie McDonald

Laura Bellamy

Jenifer Schlotfeldt

Gretchen Hargis

Ann Kilty Hernandez

Polly Hughes

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.

DITA, Quality, and Style

Best Practices for Technical Writers and Editors, Video Enhanced Edition (Collection)

IBM Redbooks

Maryela Weihrauch

Frank van der Wal

Rafael Toshio Saizaki

Kendrick Ren

Hendrik Mynhard

Benedict Holste

Maria Sueli Almeida

The goal of this IBM® Redbooks® publication is to demonstrate the ability to perform single click automated deployments of multi-platform applications that include IBM Db2 for z/OS database schema changes by using the capabilities of IBM Db2 DevOps Experience for z/OS. Pushing the application and database code changes to a source control management system (SCM) triggers a single CI/CD pipeline execution for application and database changes. Therefore, it mitigates the dependency on the DBA to deploy those database changes in a separate process. At the same time, DBAs can safeguard the integrity of their organization's data by implementing site rules in Db2 DevOps Experience. DBAs define whether a schema change can be approved automatically after all site rules are satisfied or whether it must be approved manually. In this publication, we e provide an overview of the CI/CD pipeline architecture in the context of a sample application. We also describe the steps that are relevant to the roles of the DevOps engineer who implements the enterprise CI/CD pipeline, the DBA who is responsible for database code changes in Db2 for z/OS and for defining site rules that ensure quality in production, and the application developer who changes the application code and communicates requirements for changes in the database schema.

Integrating Db2 for z/OS Database Changes Into a CI/CD Pipeline

Eric Radzinski

About

Books

Join the club