Quality Of Technical Documentation

Author :
Publisher : BRILL
ISBN 13 : 9004484515
Total Pages : 275 pages
Book Rating : 4.11/5 ( download)

DOWNLOAD NOW!

Download or read book Quality of technical documentation written by and published by BRILL. This book was released on 2021-11-22 with total page 275 pages. Available in PDF, EPUB and Kindle. Book excerpt: 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 13 : 0137034784
Total Pages : 550 pages
Book Rating : 4.89/5 ( download)

DOWNLOAD NOW!

Download or read book Developing Quality Technical Information written by Gretchen Hargis and published by Pearson Education. This book was released on 2004-04-06 with total page 550 pages. Available in PDF, EPUB and Kindle. Book excerpt: "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 : Andrew J. Marlow
Publisher :
ISBN 13 : 9781873407097
Total Pages : 47 pages
Book Rating : 4.92/5 ( download)

DOWNLOAD NOW!

Download or read book Quality Control for Technical Documentation written by Andrew J. Marlow and published by . This book was released on 2005 with total page 47 pages. Available in PDF, EPUB and Kindle. Book excerpt: Quality Control for Technical Documentation has been written primarily for practising technical communicators, but might equally be useful to the student serious about pursuing a career in technical documentation, or engineers and programmers looking to embrace a change of vocation in whole or in part. The purpose of this book is to foster the idea that quality management should be an integral part of every technical documentation project. Without teaching any particular philosophy, the book introduces the technical communicator to a variety of approaches to quality control. It discusses techniques and procedures that can help the technical communicator formulate a programme designed to improve the quality of technical documentation. There are chapters on an introduction to quality management systems, defining a strategy for quality control, the review process and quality assessment.

Author : Marc Achtelig
Publisher : Indoition Publishing E.K.
ISBN 13 : 9783943860023
Total Pages : 224 pages
Book Rating : 4.27/5 ( download)

DOWNLOAD NOW!

Download or read book Translating Technical Documentation Without Losing Quality written by Marc Achtelig and published by Indoition Publishing E.K.. This book was released on 2012 with total page 224 pages. Available in PDF, EPUB and Kindle. Book excerpt: 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

Author : Susan K. Schultz
Publisher : Digital Press
ISBN 13 : 148329627X
Total Pages : 334 pages
Book Rating : 4.72/5 ( download)

DOWNLOAD NOW!

Download or read book The Digital Technical Documentation Handbook written by Susan K. Schultz and published by Digital Press. This book was released on 2014-06-28 with total page 334 pages. Available in PDF, EPUB and Kindle. Book excerpt: The Digital Technical Documentation Handbook describes the process of developing and producing technical user information at Digital Equipment Corporation. * Discusses techniques for making user information _more effective * Covers the draft and review process, the production and distribution of printed and electronic media, archiving, indexing, testing for usability, and many other topics * Provides quality assurance checklists, contains a glossary and a bibliography of resources for technical communicators

Author : Jerry C. Whitaker
Publisher : CRC Press
ISBN 13 : 1351833030
Total Pages : 198 pages
Book Rating : 4.35/5 ( download)

DOWNLOAD NOW!

Download or read book Technical Documentation and Process written by Jerry C. Whitaker and published by CRC Press. This book was released on 2018-09-03 with total page 198 pages. Available in PDF, EPUB and Kindle. Book excerpt: 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 : Jared Bhatti
Publisher : Apress
ISBN 13 : 9781484272169
Total Pages : 0 pages
Book Rating : 4.61/5 ( download)

DOWNLOAD NOW!

Download or read book Docs for Developers written by Jared Bhatti and published by Apress. This book was released on 2021-10-01 with total page 0 pages. Available in PDF, EPUB and Kindle. Book excerpt: 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 : Microsoft Corporation
Publisher : Pearson Education
ISBN 13 : 0735669791
Total Pages : 969 pages
Book Rating : 4.96/5 ( download)

DOWNLOAD NOW!

Download or read book Microsoft Manual of Style written by Microsoft Corporation and published by Pearson Education. This book was released on 2012-01-15 with total page 969 pages. Available in PDF, EPUB and Kindle. Book excerpt: Maximize the impact and precision of your message! Now in its fourth edition, the Microsoft Manual of Style provides essential guidance to content creators, journalists, technical writers, editors, and everyone else who writes about computer technology. Direct from the Editorial Style Board at Microsoft—you get a comprehensive glossary of both general technology terms and those specific to Microsoft; clear, concise usage and style guidelines with helpful examples and alternatives; guidance on grammar, tone, and voice; and best practices for writing content for the web, optimizing for accessibility, and communicating to a worldwide audience. Fully updated and optimized for ease of use, the Microsoft Manual of Style is designed to help you communicate clearly, consistently, and accurately about technical topics—across a range of audiences and media.

Author : Evan Aksen
Publisher :
ISBN 13 :
Total Pages : 116 pages
Book Rating : 4.15/5 ( download)

DOWNLOAD NOW!

Download or read book Quality Assurance & Technical Documentation written by Evan Aksen and published by . This book was released on 2020-09-16 with total page 116 pages. Available in PDF, EPUB and Kindle. Book excerpt: Quality Assurance is a fancy name for software testing. It is the part of the application cycle that developers should not do because no one can 'proofread' his own work. Technical Documentation is the written prose of the Development World. Also tucked in this section are directions on how to write user information. This book differentiates itself in that it is short: 107 pages of text with graphics as well as checklists. Why not a longer ode to my profession? Because this book was born out of my sample book that I take on assignment interviews. If you have read my biographical information, you know that I am a self-employed consultant. Can you picture me sitting on a client interview showing a 500 page book in order to demonstrate that I can test? Probably not -> and neither could I.

Author : Institute of Medicine
Publisher : National Academies Press
ISBN 13 : 0309072808
Total Pages : 360 pages
Book Rating : 4.09/5 ( download)

DOWNLOAD NOW!

Download or read book Crossing the Quality Chasm written by Institute of Medicine and published by National Academies Press. This book was released on 2001-08-19 with total page 360 pages. Available in PDF, EPUB and Kindle. Book excerpt: Second in a series of publications from the Institute of Medicine's Quality of Health Care in America project Today's health care providers have more research findings and more technology available to them than ever before. Yet recent reports have raised serious doubts about the quality of health care in America. Crossing the Quality Chasm makes an urgent call for fundamental change to close the quality gap. This book recommends a sweeping redesign of the American health care system and provides overarching principles for specific direction for policymakers, health care leaders, clinicians, regulators, purchasers, and others. In this comprehensive volume the committee offers: A set of performance expectations for the 21st century health care system. A set of 10 new rules to guide patient-clinician relationships. A suggested organizing framework to better align the incentives inherent in payment and accountability with improvements in quality. Key steps to promote evidence-based practice and strengthen clinical information systems. Analyzing health care organizations as complex systems, Crossing the Quality Chasm also documents the causes of the quality gap, identifies current practices that impede quality care, and explores how systems approaches can be used to implement change.