What is Documentation?
Title | What is Documentation? PDF eBook |
Author | Suzanne Briet |
Publisher | Scarecrow Press |
Pages | 88 |
Release | 2006 |
Genre | Language Arts & Disciplines |
ISBN | 9780810851092 |
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
Title | Docs Like Code PDF eBook |
Author | Anne Gentle |
Publisher | Lulu.com |
Pages | 118 |
Release | 2017-09-09 |
Genre | Computers |
ISBN | 1387081322 |
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.
What is Documentation
Title | What is Documentation PDF eBook |
Author | Manuel Guzman |
Publisher | HURIDOCS |
Pages | 39 |
Release | 2001 |
Genre | Archives |
ISBN | 9295015053 |
Docs for Developers
Title | Docs for Developers PDF eBook |
Author | Jared Bhatti |
Publisher | Apress |
Pages | 0 |
Release | 2021-10-01 |
Genre | Computers |
ISBN | 9781484272169 |
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.
DocBook 5: The Definitive Guide
Title | DocBook 5: The Definitive Guide PDF eBook |
Author | Norman Walsh |
Publisher | "O'Reilly Media, Inc." |
Pages | 552 |
Release | 2010-04-20 |
Genre | Computers |
ISBN | 1449390692 |
If you need a reliable tool for technical documentation, this clear and concise reference will help you take advantage of DocBook, the popular XML schema originally developed to document computer and hardware projects. DocBook 5.0 has been expanded and simplified to address documentation needs in other fields, and it's quickly becoming the tool of choice for many content providers. DocBook 5: The Definitive Guide is the complete, official documentation of DocBook 5.0. You'll find everything you need to know to use DocBook 5.0's features-including its improved content model-whether you're new to DocBook or an experienced user of previous versions. Learn how to write DocBook XML documents Understand DocBook 5.0's elements and attributes, and how they fit together Determine whether your documents conform to the DocBook schema Learn about options for publishing DocBook to various output formats Customize the DocBook schema to meet your needs Get additional information about DocBook editing and processing
The Product is Docs
Title | The Product is Docs PDF eBook |
Author | Christopher Gales |
Publisher | |
Pages | 287 |
Release | 2020 |
Genre | New products |
ISBN |
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.
Complete Guide to Documentation
Title | Complete Guide to Documentation PDF eBook |
Author | LIPPINCOTT |
Publisher | |
Pages | 448 |
Release | 2012-05-01 |
Genre | Medical |
ISBN | 9781609136185 |
Everything the nurse needs to know to make documenting patient care better, faster, safer, comprehensive, yet concise. Clear, practical documentation guidelines for all current documentation systems, including electronic medical records EMRs and all practice settings. Hundreds of filled-in sample forms and examples show specific content and wording, legal and ethical dos and donts.