Agile Documentation


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.




Language Documentation


Book Description

"Language documentation," also often called "documentary linguistics," is a relatively new subfield in linguistics which has emerged in part as a response to the pressing need for collecting, describing, and archiving material on the increasing number of endangered languages. The present book details the most recent developments in this rapidly developing field with papers written by linguists primarily based in academic institutions in North America, although many conduct their fieldwork elsewhere. The articles in this volume position papers and case studies focus on some of the most critical issues in the field. These include (1) the nature of contributions to linguistic theory and method provided by documentary linguistics, including the content appropriate for documentation; (2) the impact and demands of technology in documentation; (3) matters of practice in collaborations among linguists and communities, and in the necessary training of students and community members to conduct documentation activities; and (4) the ethical issues involved in documentary linguistics."




Introduction to Documentation Studies


Book Description

Documentation has always been crucial in human society. Today almost all communication are being stored digitally. In order to deal systematically and coherently with old and new media in the world today, you have to deal with the physical as well as the social and cultural context. Alongside this, there is now increasing interest in documentation theory and science, and documentation studies has become a distinctly lively field of research as well as a basis for professional practice in libraries, archives and museums. This groundbreaking new book introduces and demonstrates the value and relevance of a new approach to the documentation, communication and information field, complementary to the traditional library, information and archival sciences. It offers an introduction to documentation studies - a new discipline within the overall information studies umbrella - and gives a broad and general theory for documentation. It outlines the historical background and the theoretical foundation for the discipline by giving insight into documentation issues and processes from early modern society to today's digital age: not only in the context of academic study, but also in the practice of documentation, both in everyday life and in professional life. Key topics covered include: Human life in a documentation perspective Documentation in theory Documentation: a conceptual history A complementary theory of documentation A model for documentation analysis Documentation in practice: 6 case studies Documentation in society The science and profession of documentation. This unique text outlines the main scientific purpose and objective of the science of documentation; to study documentation in society. It also describes the main skills for a documentalist in the 21st century; to be able to select, collect and make accessible all documentation of possible interest for the general public as well as research. This book will be pivotal reading for students (advanced undergraduate and graduate), researchers, and faculty in library science, information science, records management, publishing, media studies, cultural studies, archival studies, and information systems. It will also be of interest to thoughtful professionals in libraries, archives, records and media. 010




The Clinical Documentation Sourcebook


Book Description

All the forms, handouts, and records mental health professionals need to meet documentation requirements–fully revised and updated The paperwork required when providing mental health services continues to mount. Keeping records for managed care reimbursement, accreditation agencies, protection in the event of lawsuits, and to help streamline patient care in solo and group practices, inpatient facilities, and hospitals has become increasingly important. Now fully updated and revised, the Fourth Edition of The Clinical Documentation Sourcebook provides you with a full range of forms, checklists, and clinical records essential for effectively and efficiently managing and protecting your practice. The Fourth Edition offers: Seventy-two ready-to-copy forms appropriate for use with a broad range of clients including children, couples, and families Updated coverage for HIPAA compliance, reflecting the latest The Joint Commission (TJC) and CARF regulations A new chapter covering the most current format on screening information for referral sources Increased coverage of clinical outcomes to support the latest advancements in evidence-based treatment A CD-ROM with all the ready-to-copy forms in Microsoft® Word format, allowing for customization to suit a variety of practices From intake to diagnosis and treatment through discharge and outcome assessment, The Clinical Documentation Sourcebook, Fourth Edition offers sample forms for every stage of the treatment process. Greatly expanded from the Third Edition, the book now includes twenty-six fully completed forms illustrating the proper way to fill them out. Note: CD-ROM/DVD and other supplementary materials are not included as part of eBook file.




Technical Documentation and Process


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.




Guide to Clinical Documentation


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.




Docs Like Code


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.




Living Documentation


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




Pedagogical Documentation in Early Childhood Education


Book Description

Today, the documentation of children's education and development is an important part of educational work in early childhood education. This book systematises the topic of pedagogical documentation based on current empirical research. The book analyses different pedagogical reasons for documentation and then presents and discusses different procedures of pedagogical documentation in theory and empirical practice : Portfolio, Learning Stories, pedagogical documentation in the room, project documentation and digital pedagogical documentation. Pedagogical documentation is discussed in the tension between a social constructivist understanding of education on the one hand and a diagnostic logic of fostering on the other. The book is intended as a part of pedagogically oriented childhood research, which also wants to contribute to the reflection and improvement of pedagogical practice.




Principles of Investigative Documentation (2nd Edition)


Book Description

This is the only book in existence that discusses the process of documenting an investigation from start to finish. It presents just about everything an investigator needs to know regarding how to document an investigation. This new edition builds upon the principles outlined in the first edition, but the new edition has a criminal defense bent, with numerous case examples provided that include insurance claims and civil litigation, criminal defense, murders, sexual assaults, and other serious felonies, particularly wrongful convictions. These require meticulous documentation. Proper documentation matters most in criminal cases. This book therefore will focus also on the rights of those accused of crimes. The first chapter discusses the five primary principles of investigative documentation: taking comprehensive notes; documenting every effort to contact witnesses and all surveillance; preparing reports whenever there is any possibility of needing to testify; taking verbatim statements from hostile witnesses and declarations from friendly witnesses; and providing all case documents to the client or maintaining a document retention plan. The second chapter details the numerous misconceptions pertaining to investigative documentation. This chapter sets the stage for the remaining chapters on note-taking, running resumes, reports, statements, and documentation retention. Each chapter is broken down into four or five sections that approximate the methods used to complete that particular documentary endeavor. The book also contains an exhaustive appendix that many investigators will find to be very useful. This is an advanced book for people who already have the necessary skills to do an investigation. By following the principles outlined in this book, investigators will see the quality of their investigations improve markedly and ultimately be more successful. Although the authors have chosen to refocus the second edition on criminal defense investigations, where proper documentation is most important, the principles herein remain the benchmark of how to document any investigation in the private sector.