The Art of Technical Documentation PDF Download

Author: Katherine Haramundanis
Publisher: Digital Press
ISBN: 1483184013
Category : Computers
Languages : en
Pages : 287

View

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: Christopher Gales
Publisher:
ISBN:
Category : New products
Languages : en
Pages : 287

View

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:
Publisher: BRILL
ISBN: 9004484515
Category : Language Arts & Disciplines
Languages : en
Pages : 275

View

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: Jerry C. Whitaker
Publisher: CRC Press
ISBN: 1439861609
Category : Technology & Engineering
Languages : en
Pages : 195

View

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: Marc Achtelig
Publisher:
ISBN: 9783943860139
Category :
Languages : en
Pages : 230

View

Book Description
Aesthetics isn't the only thing that you should be striving for when desiging a user manual template or the style sheet of an online help system. When creating technical documentation, usability, readability, and simplicity are at least just as crucial. The design should please the eye, but at the same time it must communicate the content clearly. In addition, paragraph styles and character styles should be efficient to use for the author when writing the document. The layout process should be automated as much as possible. Because most user assistance documents are frequently updated during theit life cycle, an automated layout process is much more important here than with other kinds of literature. Setting up templates and style sheets that are efficient to use when creating and updating user assistance requires a lot of experience in technical writing. The rules presented in this book are the essence of this experience. All chapters provide various examples that you can use for inspiration and as starting points for your own designs. Topics covered: Layout basics Setting the type area Choosing fonts and spacing Creating semantic styles Organizing styles hierarchically Recommended screen layouts Recommended page layouts Recommended table designs Recommended paragraph styles Recommended character styles

Author: Leo Finkelstein
Publisher: McGraw-Hill Science, Engineering & Mathematics
ISBN: 9780072370805
Category : Technical writing
Languages : en
Pages : 0

View

Book Description
The focus of this text is to teach engineering students the skill of technical writing. It takes a project oriented approach and covers writing functions that are of particular use to the engineering student. This book is part of the B.E.S.T. Series.

Author: Susan K. Schultz
Publisher: Digital Press
ISBN: 148329627X
Category : Computers
Languages : en
Pages : 334

View

Book Description
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: Vijay Bhatia
Publisher: Routledge
ISBN: 1317916433
Category : Language Arts & Disciplines
Languages : en
Pages : 613

View

Book Description
The Routledge Handbook of Language and Professional Communication provides a broad coverage of the key areas where language and professional communication intersect and gives a comprehensive account of the field. The four main sections of the Handbook cover: Approaches to Professional Communication Practice Acquisition of Professional Competence Views from the Professions This invaluable reference book incorporates not only an historical view of the field, but also looks to possible future developments. Contributions from international scholars and practitioners, focusing on specific issues, explore the major approaches to professional communication and bring into focus recent research. This is the first handbook of language and professional communication to account for both pedagogic and practitioner perspectives and as such is an essential reference for postgraduate students and those researching and working in the areas of applied linguistics and professional communication.

Author: Central Institute for Technical Documentation
Publisher:
ISBN:
Category :
Languages : en
Pages :

View

Book Description

Author: Anne Gentle
Publisher: Lulu.com
ISBN: 1387081322
Category : Computers
Languages : en
Pages : 118

View

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.