Technical Documentation And Process

Author: Jerry C. Whitaker
Publisher: CRC Press
ISBN: 1439861609
Size: 14.24 MB
Format: PDF, Mobi
View: 3784
Download Read Online
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.

The Art Of Technical Documentation

Author: Katherine Haramundanis
Publisher: Digital Press
ISBN: 1483184013
Size: 41.61 MB
Format: PDF, ePub
View: 393
Download Read Online
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.

The Digital Technical Documentation Handbook

Author: Susan Schultz
Publisher: Digital Press
ISBN: 148329627X
Size: 28.73 MB
Format: PDF, ePub, Mobi
View: 2667
Download Read Online
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

Agile Documentation

Author: Andreas Rüping
Publisher: John Wiley & Sons
ISBN: 0470856246
Size: 26.37 MB
Format: PDF, Mobi
View: 322
Download Read Online
Software documentation forms the basis for all communication relating to a software project. To be truly effective and usable, it should be based on what needs to be known. Agile Documentation provides sound advice on how to produce lean and lightweight software documentation. It will be welcomed by all project team members who want to cut out the fat from this time consuming task. Guidance given in pattern form, easily digested and cross-referenced, provides solutions to common problems. Straightforward advice will help you to judge: What details should be left in and what left out When communication face-to-face would be better than paper or online How to adapt the documentation process to the requirements of individual projects and build in change How to organise documents and make them easily accessible When to use diagrams rather than text How to choose the right tools and techniques How documentation impacts the customer Better than offering pat answers or prescriptions, this book will help you to understand the elements and processes that can be found repeatedly in good project documentation and which can be shaped and designed to address your individual circumstance. The author uses real-world examples and utilises agile principles to provide an accessible, practical pattern-based guide which shows how to produce necessary and high quality documentation.

Quality Of Technical Documentation

Author: Michaël Steehouder
Publisher: Rodopi
ISBN: 9789051836271
Size: 36.29 MB
Format: PDF, Mobi
View: 6676
Download Read Online
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.

Engineering Procedures Handbook

Author: Phillip A. Cloud
Publisher: William Andrew
ISBN: 081551705X
Size: 57.68 MB
Format: PDF, Mobi
View: 5315
Download Read Online
This handbook is a new systematic approach to engineering documentation, therefore, it will simplify the end users ability to set up or enhance their engineering documentation requirements. Companies with small manual systems to large-scale mass production facilities can use this handbook to tailor their engineering documentation requirements. If an individual or company wishes to create or improve an engineering documentation system, there is no need to start from scratch. Instead, use this new handbook, complete with 47 specially designed forms and with procedures that cover every major aspect of a comprehensive engineering documentation system. Another book published by Noyes, Engineering Documentation Control Handbook can be very helpful if used in conjunction with this handbook. This book contains 62 engineering procedures and 27 forms. Most of these engineering procedures are influenced by the author's background in aircraft, aerospace, and the computer industry. The manufacture of Printed Circuit Boards was used as an example throughout the book. However, the principles are applicable to all engineering and operational disciplines.

Managing Writers

Author: Richard Hamilton
Publisher: XML Press
ISBN: 1457182262
Size: 59.45 MB
Format: PDF, Kindle
View: 7051
Download Read Online
Managing Writers is a practical guide to managing documentation projects in the real world. It is informal, but concise, using examples from the author's experience working with and managing technical writers. It looks beyond big project, big team methodologies to the issues faced by smaller, less well-funded projects. Managing Writers is for technical writers, both freelancers and employees, documentation managers, and managers in other disciplines who are responsible for documentation; anyone who may need to manage, full or part-time, a documentation project. Inside the Book Leading People Leading Projects Leading Technology Glossary, Bibliography, and Index

Technical Translation

Author: Jody Byrne
Publisher: Springer Science & Business Media
ISBN: 1402046537
Size: 23.57 MB
Format: PDF
View: 4114
Download Read Online
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.

Document Analysis Systems Vi

Author: Simone Marinai
Publisher: Springer
ISBN: 3540286403
Size: 56.64 MB
Format: PDF, Kindle
View: 3351
Download Read Online
Thisvolumecontainspapersselectedforpresentationatthe6thIAPRWorkshop on Document Analysis Systems (DAS 2004) held during September 8–10, 2004 at the University of Florence, Italy. Several papers represent the state of the art in a broad range of “traditional” topics such as layout analysis, applications to graphics recognition, and handwritten documents. Other contributions address the description of complete working systems, which is one of the strengths of this workshop. Some papers extend the application domains to other media, like the processing of Internet documents. The peculiarity of this 6th workshop was the large number of papers related to digital libraries and to the processing of historical documents, a taste which frequently requires the analysis of color documents. A total of 17 papers are associated with these topics, whereas two yearsago (in DAS 2002) only a couple of papers dealt with these problems. In our view there are three main reasons for this new wave in the DAS community. From the scienti?c point of view, several research ?elds reached a thorough knowledge of techniques and problems that can be e?ectively solved, and this expertise can now be applied to new domains. Another incentive has been provided by several research projects funded by the EC and the NSF on topics related to digital libraries.