The Ibm Style Guide Conventions For Writers And Editors Ibm Press PDF EPUB Download
The Ibm Style Guide Conventions For Writers And Editors Ibm Press also available in docx and mobi. Read The Ibm Style Guide Conventions For Writers And Editors Ibm Press online, read in mobile or Kindle.
The IBM Style Guide distills IBM wisdom for developing superior content: information that is consistent, clear, concise, and easy to translate. The IBM Style Guide can help any organization improve and standardize content across authors, delivery mechanisms, and geographic locations. This expert guide contains practical guidance on topic-based writing, writing content for different media types, and writing for global audiences. Throughout, the authors illustrate the guidance with many examples of correct and incorrect usage. Writers and editors will find authoritative guidance on issues ranging from structuring information to writing usable procedures to presenting web addresses to handling cultural sensitivities. The guidelines cover these topics: Using language and grammar to write clearly and consistently Applying punctuation marks and special characters correctly Formatting, organizing, and structuring information so that it is easy to find and use Using footnotes, cross-references, and links to point readers to valuable, related information Presenting numerical information clearly Documenting computer interfaces to make it easy for users to achieve their goals Writing for diverse audiences, including guidelines for improving accessibility Preparing clear and effective glossaries and indexes The IBM Style Guide can help any organization or individual create and manage content more effectively. The guidelines are especially valuable for businesses that have not previously adopted a corporate style guide, for anyone who writes or edits for IBM as an employee or outside contractor, and for anyone who uses modern approaches to information architecture.
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.
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 Roadmap for Writing, Editing, and Architecting in DITA
Author: Laura Bellamy
Publisher: IBM Press
The complete, best-practice guide to implementing and using DITA: expert, 'in the trenches' advice you can't find anywhere else! • •Answers the crucial questions the 'official' DITA documentation doesn't cover, from 'Where do you start?' to 'How do you avoid the pitfalls?' •Reflects the authors' unsurpassed experience in all facets of enterprise-scale DITA planning, deployment, and day-to-day usage. •Offers practical guidance on topic-based writing, content architecture, and ensuring a quality implementation. Darwin Information Typing Architecture (DITA) is today's most powerful toolbox for constructing information. Implementing DITA can help organizations significantly improve the value of their technical documentation. This book brings together best practices and real-world guidance for success with DITA deployment and usage. Drawing on years of experience helping organizations implement DITA, the authors answer the crucial questions the 'official' DITA documents ignore: • •Where do you start in implementing DITA? •What should you know before you start writing? •What are DITA's gotchas and pitfalls? •Which DITA elements, attributes, and features should you know upfront, and which can wait? Technical writers and their managers can use this book as a complete roadmap for DITA adoption and implementation. Part 1 walks through the basics of topic-based writing, especially the importance of writing accurate, usable short descriptions. Part 2 covers more advanced topics related to content architecture, including DITA maps, linking strategies, metadata, conditional processing, and content reuse. Part 3 covers quality DITA implementations, offering crucial guidance for converting content to DITA, whether you do it in-house or utilize a third-party vendor.
Every complex product needs to be explained to its users, and technical writers, also known as technical communicators, are the ones who do that job. A growing field, technical writing requires multiple skills, including an understanding of technology, writing ability, and great people skills. Whether you're thinking of becoming a technical writer, just starting out, or you've been working for a while and feel the need to take your skills to the next level, The Insider's Guide to Technical Writing can help you be a successful technical writer and build a satisfying career. Inside the Book Is This Job for Me? What does it take to be a technical writer? Building the Foundation: What skills and tools do you need to get started? The Best Laid Plans: How do you create a schedule that won’t make you go crazy? How do you manage different development processes, including Agile methodologies? On the Job: What does it take to walk into a job and be productive right away? The Tech Writer Toolkit: How do you create style guides, indexes, templates and layouts? How do you manage localization and translation and all the other non-writing parts of the job? I Love My Job: How do you handle the ups and downs of being a technical writer? Appendixes: References to websites, books, and other resources to keep you learning. Index
A Roadmap for Writing, Editing, and Architecting in DITA
Author: Laura Bellamy
Publisher: Pearson Education
Category: Technology & Engineering
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
Now in its eleventh edition, Writing and Reporting for the Media continues to be a top resource for journalism courses. A fundamental introduction to newswriting and reporting, this classic text focuses on the basics of reporting, including critical thinking, thorough reporting, excellentwriting and creative visual communication skills for stories across all media.
Part of the new Allyn & Bacon series in technical communication, Writing Software Documentation features a step-by-step strategy to writing and describing procedures. This task-oriented book is designed to support both college students taking a course and professionals working in the field. Teaching apparatus includes complete programs for students to work on and a full set of project tracking forms, as well as a broad range of examples including Windows-style pages and screens and award-winning examples from STC competitions.