Everything about Documentation
Set of documents providing knowledge to explain a system
Documentation is any communicable material that is used to describe, explain, or instruct regarding some attributes of an object, system, or procedure, such as its parts, assembly, installation, maintenance, and use. As a form of knowledge management and knowledge organization, documentation can be provided on paper, online, or on digital or analog media, such as audio tape or CDs. Examples of such resources include user guides, white papers, online help, and quick-reference guides. Paper or hard-copy documentation has become less common. Contemporary documentation is often distributed through websites, software products, and other online applications. Wikipedia â
đ§ Start here: a 6-step reading path
- Read the overview: DocumentationA 5-minute orientation
- Skim a recent paper: Ambient Artificial Intelligence Scribes to Alleviate the Burden of Clinical DocumentationInfluential work since 2022
- Pick up a classic book: 1990 census of population and housingThe most-reprinted book on the subject
- Read the landmark paper: The NCEPâNCAR 50âYear Reanalysis: Monthly Means CDâROM and DocumentationCited 2,998 times
- Go sideways: Configuration managementA closely related topic
- Go sideways: Specification (technical standard)A closely related topic
đ Definitions
Noun Something transposed from a thought to a document; the written account of an idea.
Noun Documentary evidence and sources.
Noun Documents that explain the operation of a particular machine or software program.
Noun Comments that explain the usage of individual functions, libraries and blocks of code.
đ Landmark papers (most cited)
The NCEPâNCAR 50âYear Reanalysis: Monthly Means CDâROM and Documentation
Development and Validation of the International Knee Documentation Committee Subjective Knee Form
The Global Burden of Headache: A Documentation of Headache Prevalence and Disability Worldwide
Improved 206Pb/238U microprobe geochronology by the monitoring of a trace-element-related matrix effect; SHRIMP, IDâTIMS, ELAâICPâMS and oxygen isotope documentation for a series of zircon standards
Measures of knee function: International Knee Documentation Committee (IKDC) Subjective Knee Evaluation Form, Knee Injury and Osteoarthritis Outcome Score (KOOS), Knee Injury and Osteoarthritis Outcome Score Physical Function Short Form (KOOSâPS), Knee Outcome Survey Activities of Daily Living Scale (KOSâADL), Lysholm Knee Scoring Scale, Oxford Knee Score (OKS), Western Ontario and McMaster Universities Osteoarthritis Index (WOMAC), Activity Rating Scale (ARS), and Tegner Activity Score (TAS)
DOCUMENTATION NOTES
The InterPro database, an integrated documentation resource for protein families, domains and functional sites
Spatially Located Platform and Aerial Photography for Documentation of Grazing Impacts on Wheat
đ Influential since 2022
Ambient Artificial Intelligence Scribes to Alleviate the Burden of Clinical Documentation
Clinician Experiences With Ambient Scribe Technology to Assist With Documentation Burden and Efficiency
The Swedish medical birth register during five decades: documentation of the content and quality of the register
Ambient artificial intelligence scribes: physician burnout and perspectives on usability and documentation burden
Large Language ModelâBased Chatbot vs Surgeon-Generated Informed Consent Documentation for Common Procedures
đ Books worth reading
- đ1990 census of population and housingUnited States. Bureau of the Census · 1992
Civil DisobedienceHenry David Thoreau · 1800
On WritingStephen King · 1999
Go Ask AliceBeatrice Sparks · 1971
The Columbian OratorCaleb Bingham · 1797
Come, tell me how you liveAgatha Christie · 1946
Eiger DreamsJon Krakauer · 1990
I Feel Bad About My NeckNora Ephron · 1998
Ranked by number of editions on Open Library, a rough measure of how lasting a book is.
đ Related topics
- Configuration management Configuration management (CM) is a management process for establishing and maintaining consistency of a product's performance, functional, and physicalâŠ
- Specification (technical standard) A specification, colloquially spec, often refers to a set of documented requirements to be satisfied by a material, design, product, or service. A specificationâŠ
- Document management system A document management system (DMS) is a computerized system used to store, share, track and manage electronic files or documents. Some systems includeâŠ
- Software documentation Software documentation is written text or illustration that accompanies computer software or is embedded in the source code. The documentation either explainsâŠ
- Technical documentation Technical documentation is a generic term for the classes of information created to describe (in technical language) the use, functionality, or architectureâŠ
- Computer accessibility Computer accessibility refers to the accessibility of a computer system to all people, regardless of disability type, English literacy or digital fluencyâŠ
- Technical writing Technical writing is a specialized form of communication used by industrial and scientific organizations to clearly and accurately convey complex informationâŠ
- Acceptance testing In engineering and its various subdisciplines, acceptance testing is a test conducted to determine if the requirements of a specification or contract areâŠ