What is Documentation
Author: Manuel Guzman
Publisher: HURIDOCS
Published: 2001
Total Pages: 39
ISBN-13: 9295015053
DOWNLOAD EBOOKPosts
The Product is Docs
Author: Christopher Gales
Publisher:
Published: 2020
Total Pages: 287
ISBN-13:
DOWNLOAD EBOOKThis 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.
Effective Documentation
Author: Stephen Doheny-Farina
Publisher: MIT Press
Published: 1988
Total Pages: 376
ISBN-13: 9780262040983
DOWNLOAD EBOOK"Best Collection of Essays", NCTE Awards for Excellence in Technical and Scientific Communication. Effective Documentation is a major sourcebook that offers technical writers, editors, teachers, and students of technical communication a wide variety of practical guidelines based on often hard to find research in the usability of printed and electronic media. The book's eighteen chapters provide a wealth of material on such topics of current interest as the writing of design manuals, research in cognitive psychology as applied to the design of user manuals, and the organizing of manuals for hierarchical software systems. Included are chapters by such well known scholars in the field as Philip Rubens, Robert Krull, Judith Ramey, and John Carroll. Effective Documentation reviews the advice offered by other "how to produce usable documentation" books, describing the different types of usability research and explaining the inherent biases of each type. It goes beyond the actual design of textual and/or electronic media to look at these designs in context, giving advice on effective management ("good management is a requisite of good writing"), on the relationship between document design and product design, and on how to find out who one's readers really are. Advances in the presentation of textual information are explained, with suggestions on how to improve the usability of individual sentences and the design of entire books. The concluding chapters discuss advances in the design and use of online information and offer valuable insights into the use of graphic information and the development and design of information communicated via electronic media. Stephen Doheny Farina is Assistant Professor of Technical Communication at Clarkson University. Effective Documentationis included in the Information Systems series, edited by Michael Lesk.
Perspectives on Software Documentation
Author: Thomas Barker
Publisher: Routledge
Published: 2020-11-25
Total Pages: 288
ISBN-13: 1351842315
DOWNLOAD EBOOKThis book is designed to address the randomness of the literature on software documentation. As anyone interested in software documentation is aware, the field is highly synthetic; information about software documentation may be found in engineering, computer science training, technical communication, management, education and so on. "Perspectives on Software Documentation" contains a variety of perspectives, all tied together by the shared need to make software products more usable.
Computer Systems Engineering Management
Author: Robert S. Alford
Publisher: CRC Press
Published: 2018-01-18
Total Pages: 266
ISBN-13: 135108772X
DOWNLOAD EBOOKComputer Systems Engineering Management provides a superb guide to the overall effort of computer systemsbridge building. It explains what to do before you get to the river, how to organise your work force, how to manage the construction, and what do when you finally reach the opposite shore. It delineates practical approaches to real-world development issues and problems presents many examples and case histories and explains techniques that apply to everything from microprocessors to mainframes and from person computer applications to extremely sophisticated systems
Current Research and Development in Scientific Documentation
Author:
Publisher:
Published: 1966
Total Pages: 1436
ISBN-13:
DOWNLOAD EBOOKManaging the Documentation Maze
Author: Janet Gough
Publisher: John Wiley & Sons
Published: 2010-03-16
Total Pages: 486
ISBN-13: 0470597496
DOWNLOAD EBOOKThe accessible, easy-to-follow guide that demystifies documentation management When it comes to receiving documentation to confirm good science, U.S. and international regulators place high demands on the healthcare industry. As a result, companies developing and manufacturing therapeutic products must implement a strategy that allows them to properly manage their records and documents, since they must comply with rigorous standards and be available for regulatory review or inspection at a moment’s notice. Written in a user-friendly Q&A style for quick reference, Managing the Documentation Maze provides answers to 750 questions the authors encounter frequently in their roles as consultants and trainers. In simple terms, this handy guide breaks down the key components that facilitate successful document management, and shows why it needs to be a core discipline in the industry with information on: Compliance with regulations in pharmaceutical, biological, and device record keeping Electronic systems, hybrid systems, and the entire scope of documentation that companies must manage How to write and edit documents that meet regulatory compliance Making the transition to an electronic system, including how to validate and document the process Anyone responsible for managing documents in the health field will find this book to be a trusted partner in unraveling the bureaucratic web of confusion, while it initiates a plan on how to put an effective, lasting system in place—one that will stand up to any type of scrutiny.
The Art of Technical Documentation
Author: Katherine Haramundanis
Publisher: Digital Press
Published: 2014-05-16
Total Pages: 287
ISBN-13: 1483184013
DOWNLOAD EBOOKThe 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.
Computer Model Documentation Guide
Author: Federal Computer Performance Evaluation and Simulation Center (U.S.)
Publisher:
Published: 1981
Total Pages: 68
ISBN-13:
DOWNLOAD EBOOKThe Practical Guide to People-Friendly Documentation
Author: Adrienne Escoe
Publisher: Quality Press
Published: 2001-06-30
Total Pages: 248
ISBN-13: 1636940501
DOWNLOAD EBOOKThis innovative guide brings together practical solutions to the documentation challenges faced by today's organizations. From company policies and desk instructions to Baldrige and the ISO 9000 requirements, it applies a customer and quality-based systems approach to streamlining and managing your documentation system. This second edition is an organized toolbox of powerful methodology and metrics that shows companies how to steer clear of cumbersome and obsolete documentation and gives numerous examples of the tremendous opportunities - and pitfalls - presented by technology such as the Internet and web-based documentation management software. The Society for Technical Communication (STC) awarded this book the Touchstone 2001 award.
