What is Documentation?

What is Documentation? PDF Author: Suzanne Briet
Publisher: Scarecrow Press
ISBN: 9780810851092
Category : Language Arts & Disciplines
Languages : en
Pages : 88

Get Book Here

Book Description
In 1951, when a school of information science was first established, Briet was the founding Director of Studies. She became Vice President of the International Federation for Documentation (FID) and acquired the nickname 'Madame Documentation.' This book relates her fascinating story and includes the first English translation of Briet's manifesto on the nature of documentation, a 48-page pamphlet, which sought to push the boundaries of the field beyond texts to include any material form of evidence. It also argued that a new and distinct profession was emerging and urged the societal need for new and active documentary services. Due to its continuing relevance towards understanding the nature, scope, and societal impacts of documents and documentation, Briet's modernist perspective, combined with semiotics, still deserves attention because it offers a sturdy and insightful alternative to the scientific, positivist view that has so dominated information science and which is increasingly being questioned.

What is Documentation?

What is Documentation? PDF Author: Suzanne Briet
Publisher: Scarecrow Press
ISBN: 9780810851092
Category : Language Arts & Disciplines
Languages : en
Pages : 88

Get Book Here

Book Description
In 1951, when a school of information science was first established, Briet was the founding Director of Studies. She became Vice President of the International Federation for Documentation (FID) and acquired the nickname 'Madame Documentation.' This book relates her fascinating story and includes the first English translation of Briet's manifesto on the nature of documentation, a 48-page pamphlet, which sought to push the boundaries of the field beyond texts to include any material form of evidence. It also argued that a new and distinct profession was emerging and urged the societal need for new and active documentary services. Due to its continuing relevance towards understanding the nature, scope, and societal impacts of documents and documentation, Briet's modernist perspective, combined with semiotics, still deserves attention because it offers a sturdy and insightful alternative to the scientific, positivist view that has so dominated information science and which is increasingly being questioned.

Docs Like Code

Docs Like Code PDF 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.

Agile Documentation

Agile Documentation PDF Author: Andreas Rüping
Publisher: John Wiley & Sons
ISBN: 0470856246
Category : Computers
Languages : en
Pages : 244

Get Book Here

Book Description
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.

Introduction to Documentation Studies

Introduction to Documentation Studies PDF Author: Niels Lund
Publisher:
ISBN: 9781783301904
Category :
Languages : en
Pages : 256

Get Book Here

Book Description
This unique text outlines the main scientific purpose and objective of the science of documentation and also describes the main skills for a documentalist in the 21st century.

What is Documentation

What is Documentation PDF Author: Manuel Guzman
Publisher: HURIDOCS
ISBN: 9295015053
Category : Archives
Languages : en
Pages : 39

Get Book Here

Book Description


Technical Documentation and Process

Technical Documentation and Process PDF Author: Jerry C. Whitaker
Publisher: CRC Press
ISBN: 1439861609
Category : Technology & Engineering
Languages : en
Pages : 196

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.

The Product is Docs

The Product is Docs PDF 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.

Guide to Clinical Documentation

Guide to Clinical Documentation PDF Author: Debra Sullivan
Publisher: F.A. Davis
ISBN: 0803629974
Category : Medical
Languages : en
Pages : 301

Get Book Here

Book Description
Develop the skills you need to effectively and efficiently document patient care for children and adults in clinical and hospital settings. This handy guide uses sample notes, writing exercises, and EMR activities to make each concept crystal clear, including how to document history and physical exams and write SOAP notes and prescriptions.

Living Documentation

Living Documentation PDF Author: Cyrille Martraire
Publisher: Addison-Wesley Professional
ISBN: 9780134689326
Category : Computers
Languages : en
Pages : 480

Get Book Here

Book Description
Use an Approach Inspired by Domain-Driven Design to Build Documentation That Evolves to Maximize Value Throughout Your Development Lifecycle Software documentation can come to life, stay dynamic, and actually help you build better software. Writing for developers, coding architects, and other software professionals, Living Documentation shows how to create documentation that evolves throughout your entire design and development lifecycle. Through patterns, clarifying illustrations, and concrete examples, Cyrille Martraire demonstrates how to use well-crafted artifacts and automation to dramatically improve the value of documentation at minimal extra cost. Whatever your domain, language, or technologies, you don't have to choose between working software and comprehensive, high-quality documentation: you can have both. · Extract and augment available knowledge, and make it useful through living curation · Automate the creation of documentation and diagrams that evolve as knowledge changes · Use development tools to refactor documentation · Leverage documentation to improve software designs · Introduce living documentation to new and legacy environments

The Art of Technical Documentation

The Art of Technical Documentation PDF 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.