Dita Best Practices

&>The Start-to-Finish, Best-Practice Guide to Implementing and Using DITA Darwin Information Typing Architecture (DITA) is today's most powerful toolbox for constructing information. By implementing DITA, organizations can gain more value from their technical documentation than ever before. Now, three DITA pioneers offer the first complete roadmap for successful DITA adoption, implementation, and usage. Drawing on years of experience helping large organizations adopt DITA, the authors answer crucial questions the "official" DITA documents ignore, including: Where do you start? What should you know up front? What are the pitfalls in implementing DITA? How can you avoid those pitfalls? The authors begin with topic-based writing, presenting proven best practices for developing effective topics and short descriptions. Next, they address content architecture, including how best to set up and implement DITA maps, linking strategies, metadata, conditional processing, and content reuse. Finally, they offer "in the trenches" solutions for ensuring quality implementations, including guidance on content conversion. Coverage includes: Knowing how and when to use each DITA element-and when not to Writing "minimalist," task-oriented information that quickly meets users' needs Creating effective task, concept, and reference topics for any product, technology, or service Writing effective short descriptions that work well in all contexts Structuring DITA maps to bind topics together and provide superior navigation Using links to create information webs that improve retrievability and navigation Gaining benefits from metadata without getting lost in complexity Using conditional processing to eliminate redundancy and rework Systematically promoting reuse to improve quality and reduce costs Planning, resourcing, and executing effective content conversion Improving quality by editing DITA content and XML markup If you're a writer, editor, information architect, manager, or consultant who evaluates, deploys, or uses DITA, this book will guide you all the way to success. Also see the other books in this IBM Press series: Developing Quality Technical Information: A Handbook for Writers and Editors The IBM Style Guide: Conventions for Writers and Editors

As more companies implement DITA to streamline the development of technical content, the demand for DITA-literate technical communicators is growing. The DITA Style Guide: Best Practices for Authors provides comprehensive, practical explanations of DITA elements and attributes. Real-world examples and clear recommendations show you how to create consistent, semantically correct DITA content.

If you're in the process of implementing DITA, expect to do so in the future, or just want to learn more about it without having to wade through technical specifications, this is the book for you. This book covers everything you need to know about DITA.

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

Multilingual Natural Language Processing Applications is the first comprehensive single-source guide to building robust and accurate multilingual NLP systems. Edited by two leading experts, it integrates cutting-edge advances with practical solutions drawn from extensive field experience. Part I introduces the core concepts and theoretical foundations of modern multilingual natural language processing, presenting today’s best practices for understanding word and document structure, analyzing syntax, modeling language, recognizing entailment, and detecting redundancy. Part II thoroughly addresses the practical considerations associated with building real-world applications, including information extraction, machine translation, information retrieval/search, summarization, question answering, distillation, processing pipelines, and more. This book contains important new contributions from leading researchers at IBM, Google, Microsoft, Thomson Reuters, BBN, CMU, University of Edinburgh, University of Washington, University of North Texas, and others. Coverage includes Core NLP problems, and today’s best algorithms for attacking them Processing the diverse morphologies present in the world’s languages Uncovering syntactical structure, parsing semantics, using semantic role labeling, and scoring grammaticality Recognizing inferences, subjectivity, and opinion polarity Managing key algorithmic and design tradeoffs in real-world applications Extracting information via mention detection, coreference resolution, and events Building large-scale systems for machine translation, information retrieval, and summarization Answering complex questions through distillation and other advanced techniques Creating dialog systems that leverage advances in speech recognition, synthesis, and dialog management Constructing common infrastructure for multiple multilingual text processing applications This book will be invaluable for all engineers, software developers, researchers, and graduate students who want to process large quantities of text in multiple languages, in any environment: government, corporate, or academic.

Straight from IBM: complete, proven guidelines for writing consistent, clear, concise, consumable, reusable, and easy to- translate content Brings together everything IBM has learned about writing outstanding technical and business content.

This is the video enhanced eBook version of the print title. Watch video demonstrations to see how to implement some of the advanced features of DITA discussed in this book. With these videos you’ll learn to code short descriptions, links, conditional processing, and content references. In addition, you will find instructions in the last few pages of your eBook that direct you to the download site for the set of DITA sample files used in examples throughout the book. The Start-to-Finish, Best-Practice Guide to Implementing and Using DITA Darwin Information Typing Architecture (DITA) is today’s most powerful toolbox for constructing information. By implementing DITA, organizations can gain more value from their technical documentation than ever before. Now, three DITA pioneers offer the first complete roadmap for successful DITA adoption, implementation, and usage. Drawing on years of experience helping large organizations adopt DITA, the authors answer crucial questions the “official” DITA documents ignore, including: Where do you start? What should you know up front? What are the pitfalls in implementing DITA? How can you avoid those pitfalls? The authors begin with topic-based writing, presenting proven best practices for developing effective topics and short descriptions. Next, they address content architecture, including how best to set up and implement DITA maps, linking strategies, metadata, conditional processing, and content reuse. Finally, they offer “in the trenches” solutions for ensuring quality implementations, including guidance on content conversion. Coverage includes: Knowing how and when to use each DITA element–and when not to Writing “minimalist,” task-oriented information that quickly meets users’ needs Creating effective task, concept, and reference topics for any product, technology, or service Writing effective short descriptions that work well in all contexts Structuring DITA maps to bind topics together and provide superior navigation Using links to create information webs that improve retrievability and navigation Gaining benefits from metadata without getting lost in complexity Using conditional processing to eliminate redundancy and rework Systematically promoting reuse to improve quality and reduce costs Planning, resourcing, and executing effective content conversion Improving quality by editing DITA content and XML markup If you’re a writer, editor, information architect, manager, or consultant who evaluates, deploys, or uses DITA, this book will guide you all the way to success. Important note: The audio and video content included with this enhanced eBook can be viewed only using iBooks on an iPad, iPhone, or iPod touch. 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. Also see the other books in this IBM Press series: Developing Quality Technical Information: A Handbook for Writers and Editors The IBM Style Guide: Conventions for Writers and Editors

Creating Intelligent Content with Lightweight DITA documents the evolution of the Darwin Information Typing Architecture (DITA) – a widely used open standard for structuring technical content. DITA has grown in popularity and features since its origins as an internal grammar for structuring technical documentation at IBM. This book introduces Lightweight DITA (LwDITA, which should be read as "Lightweight DITA") as a proposed version of the DITA standard that reduces its dependence on complex Extensible Markup Language (XML) structures and simplifies its authoring experience. This volume aims to reconcile discrepancies and similarities in methods for authoring content in industry and academia and does so by reporting on DITA’s evolution through the lens of computational thinking, which has been connected in scholarship and media to initiatives for learning to code and programming. Evia’s core argument is that if technical communicators are trained with principles of rhetorical problem solving and computational thinking, they can create structured content in lightweight workflows with XML, HTML5, and Markdown designed to reduce the learning curve associated with DITA and similar authoring methodologies. At the same time, this book has the goal of making concepts of structured authoring and intelligent content easier to learn and teach in humanities-based writing and communication programs. This book is intended for practitioners and students interested in structured authoring or the DITA standard.