Developing Quality Technical Information PDF Download
Are you looking for read ebook online? Search for your book and save it on your Kindle device, PC, phones or tablets. Download Developing Quality Technical Information PDF full book. Access full book title Developing Quality Technical Information by Michelle Carey. Download full books in PDF and EPUB format.
Author: Michelle Carey
Publisher: Pearson Education
ISBN: 0133118975
Category : Computers
Languages : en
Pages : 612
Get Book Here
Book Description
Drawing on IBM's unsurpassed technical communications experience, readers 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.
Author: Michelle Carey
Publisher: Pearson Education
ISBN: 0133118975
Category : Computers
Languages : en
Pages : 612
Get Book Here
Book Description
Drawing on IBM's unsurpassed technical communications experience, readers 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.
Author: Michaël Steehouder
Publisher: Rodopi
ISBN: 9789051836271
Category : Language Arts & Disciplines
Languages : en
Pages : 282
Get Book Here
Book Description
User manuals, reference guides, project documentation, equipment specifications and other technical documents are increasingly subjected to high quality standards. However, it is not clear whether research efforts are keeping pace with this increasing importance of documentation quality. This volume includes studies from researchers as well as practitioners, exemplifying three approaches towards document quality: - Product-orientation, with an eye for usability in various manifestations such as tutorials, concept definitions, tools for users of documentation to find information, methods of eliciting user feedback, and cultural differences; - Process-orientation, in which the quality of technical documentation is regarded as an outgrowth of a process involving sub-steps such as storyboarding, pre-testing and use of automation tools in writing and producing documents; - Professional orientation, in which attention is focused on those who create technical documentation. The volume will be of interest to a broad audience of writers, managers and trainers with technical and non-technical backgrounds, such as: quality managers; communication managers; technical communicators; trainers in computer usage; teachers, researchers and students of (technical) communication.
Author: Gretchen Hargis
Publisher: Pearson Education
ISBN: 0137034784
Category : Technology & Engineering
Languages : en
Pages : 550
Get Book Here
Book Description
"The examples are excellent--right on target and easy to understand and adapt. Even those who don't adopt the entire procedure can profit from the parts, but the greatest value will flow to those who adopt the whole." --Carolyn Mulford, senior writer and editor of Writing That Works "This is also a book that students can keep for their professional libraries because it will increase in its value to them after they leave class and face real life experiences on the job. It is plain enough for them to understand while they are learning, and at the same time comprehensive enough to support them as professionals." --Elizabeth Boling, Instructional Systems Technology, Indiana University "It practices what it preaches. Its guidelines are understandable and appropriate; its examples clear. It contains exactly what writers and editors need to know. It is the book that I would have written." --Cynthia E. Spellman, Unisys The #1 guide to excellence in documentation--now completely updated! A systematic, proven approach to creating great documentation Thoroughly revised and updated More practical examples More coverage of topic-based information, search, and internationalization Direct from IBM's own documentation experts, this is the definitive guide to developing outstanding technical documentation--for the Web and for print. Using extensive before-and-after examples, illustrations, and checklists, the authors show exactly how to create documentation that's easy to find, understand, and use. This edition includes extensive new coverage of topic-based information, simplifying search and retrievability, internationalization, visual effectiveness, and much more. Coverage includes: Focusing on the tasks and topics users care about most Saying more with fewer words Using organization and other means to deliver faster access to information Presenting information in more visually inviting ways Improving the effectiveness of your review process Learning from example: sample text, screen captures, illustrations, tables, and much more Whether you're a writer, editor, designer, or reviewer, if you want to create great documentation, this book shows you how!
Author: Christopher Gales
Publisher:
ISBN:
Category : New products
Languages : en
Pages : 287
Get Book Here
Book Description
This book provides a broad perspective about the essential aspects of creating technical documentation in today's product development world. It is a book of opinions and guidance, collected as short essays. You can read selectively about subjects that interest you, or you can read the entire collection in any order you like. Information development is a multidimensional discipline, and it is easy to theorize. We have written this book from our direct experience, using the concrete insights and practices we apply to our work every day. If you work as an information developer, a manager in a documentation team, or in another part of product development that collaborates with a doc team, there is information in this book for you. Perhaps you are a technical writer in a small, high-growth company that is figuring out its processes. Perhaps you are an information-development manager in a large enterprise company with an expanding product line and an ever more complex matrix of cross-functional dependencies. You might work at a medium-sized company where your management is asking you to do more with fewer people, and you want some additional perspective that will help you find a leaner and more effective way to deliver what your business demands. Or you might work outside the technical documentation world, in another part of product development, and are wondering how to collaborate most effectively with the documentation team. The purpose of The Product is Docs is to provoke discussion, shine light on some murky areas, and--we hope--inspire our colleagues to consider their processes and assumptions with new eyes. -- Amazon.
Author: Jerry C. Whitaker
Publisher: CRC Press
ISBN: 1439861609
Category : Technology & Engineering
Languages : en
Pages : 195
Get Book Here
Book Description
We live in an age of electronic interconnectivity, with co-workers across the hall and across the ocean, and managing meetings can be a challenge across multiple time zones and cultures. This makes documenting your projects more important than ever. In Technical Documentation and Process, Jerry Whitaker and Bob Mancini provide the background and structure to help you document your projects more effectively. With more than 60 years of combined experience in successfully documenting complex engineering projects, the authors guide you in developing appropriate process and documentation tools that address the particular needs of your organization. Features Strategies for documenting a project, product, or facility A sample style guide template—the foundation on which you can build documents of various types A selection of document templates Ideas for managing complex processes and improving competitiveness using systems engineering and concurrent engineering practices Basic writing standards and helpful references Major considerations for disaster planning Discussion of standardization to show how it can help reduce costs Helpful tips to manage remote meetings and other communications First-hand examples from the authors’ own experience Throughout, the authors offer practical guidelines, suggestions, and lessons that can be applied across a wide variety of project types and organizational structures. Comprehensive yet to the point, this book helps you define the process, document the plan, and manage your projects more confidently.
Author: Jody Byrne
Publisher: Springer Science & Business Media
ISBN: 1402046537
Category : Language Arts & Disciplines
Languages : en
Pages : 290
Get Book Here
Book Description
This introduction to technical translation and usability draws on a broad range of research and makes the topic both accessible and applicable to those involved in the practice and study of translation. Readers learn how to improve and assess the quality of technical translations using cognitive psychology, usability engineering and technical communication. A practical usability study illustrates the theories, methods and benefits of usability engineering.
Author: Katherine Haramundanis
Publisher: Digital Press
ISBN: 1483184013
Category : Computers
Languages : en
Pages : 287
Get Book Here
Book Description
The Art of Technical Documentation presents concepts, techniques, and practices in order to produce effective technical documentation. The book provides the definition of technical documentation; qualities of a good technical documentation; career paths and documentation management styles; precepts of technical documentation; practices for gathering information, understanding what you have gathered, and methods for testing documentation; and considerations of information representation, to provide insights on how different representations affect reader perception of your documents. Technical writers and scientists will find the book a good reference material.
Author: Anne Gentle
Publisher: Lulu.com
ISBN: 1387081322
Category : Computers
Languages : en
Pages : 118
Get Book Here
Book Description
Looking for a way to invigorate your technical writing team and grow that expertise to include developers, designers, and writers of all backgrounds? When you treat docs like code, you multiply everyone's efforts and streamline processes through collaboration, automation, and innovation. Second edition now available with updates and more information about version control for documents and continuous publishing.
Author: Jared Bhatti
Publisher: Apress
ISBN: 9781484272169
Category : Computers
Languages : en
Pages : 0
Get Book Here
Book Description
Learn to integrate programming with good documentation. This book teaches you the craft of documentation for each step in the software development lifecycle, from understanding your users’ needs to publishing, measuring, and maintaining useful developer documentation. Well-documented projects save time for both developers on the project and users of the software. Projects without adequate documentation suffer from poor developer productivity, project scalability, user adoption, and accessibility. In short: bad documentation kills projects. Docs for Developers demystifies the process of creating great developer documentation, following a team of software developers as they work to launch a new product. At each step along the way, you learn through examples, templates, and principles how to create, measure, and maintain documentation—tools you can adapt to the needs of your own organization. What You'll Learn Create friction logs and perform user research to understand your users’ frustrations Research, draft, and write different kinds of documentation, including READMEs, API documentation, tutorials, conceptual content, and release notes Publish and maintain documentation alongside regular code releases Measure the success of the content you create through analytics and user feedback Organize larger sets of documentation to help users find the right information at the right time Who This Book Is For Ideal for software developers who need to create documentation alongside code, or for technical writers, developer advocates, product managers, and other technical roles that create and contribute to documentation for their products and services.
Author: Marc Achtelig
Publisher: Indoition Publishing E.K.
ISBN: 9783943860023
Category : Science
Languages : en
Pages : 224
Get Book Here
Book Description
Translating technical documentation, such as user manuals, online help, and other types of user assistance, is essentially different from translating other forms of documents. If you translate technical documentation in the same way as you translate other texts, chances are that your clients (mostly technical writers) will be quite unhappy with the results. For example, complex language that makes a novel or sales brochure interesting can be exactly what makes a user manual incomprehensible. When translating technical documentation, you should understand how your clients have designed their documents for clearness and simplicity. Only then can your translation reflect the same principles. This book provides you with a compilation of the basic technical writing rules that every technical writer follows. When you adhere to the same rules as you translate, it's almost guaranteed that both writers and readers will be happy with the quality of your work. Audience: Professional translators
