documentation
Pluraldocumentations
- 1
- 2Documents that explain how a particular machine or software program operates.
The software shipped with detailed documentation covering installation and troubleshooting.
Engineers consulted the machine's documentation to recalibrate the sensors.
Similarinstructions, manual, guide
Note
Engineers and programmers use the word for the whole body of written explanation that comes with a product: installation guides, reference pages, troubleshooting notes. It works as a mass noun (read the documentation) and also as a count noun with the plural documentations. It stands apart from the machine or program it describes, unlike comments written into the code.
- 3Comments within code that explain how individual functions, libraries, and blocks of code are used.
Clear documentation in the source files saved the new developers hours of guesswork.
He wrote documentation for every library function before merging his changes.
Similarcomments, annotation
Note
Programmers write it for one another, not for end users. Notes beside functions and blocks of code can even be extracted automatically to build reference pages. Keep it apart from the manuals that explain a program, which tell users how to operate the software. Treat it as a mass noun: the plural documentations is rare, so a team writes more documentation, not more documentations.
- 4A film or television program presenting factual information about real events; a documentary.
The festival opened with a documentation about migrating birds.
He produced a documentation covering the war's final months.
Similardocumentary
Note
A borrowing that comes from German Dokumentation rather than from English document. It shows up in the English of non-native writers, as in Friedrich Vystrcil's 1999 line about watching "a documentation about the Dresden fire storm." Native usage has documentary here. Learners should use documentary, because to most readers "watched a documentation" sounds like a slip, not a choice.
Use it in a sentence
Write your own sentence with documentation, and AI will tell you whether it fits and which meaning you used.
Origins
This word was formed from 'document' plus the suffix '-ation', or it comes from the Medieval Latin word 'documentatio'.
This sense comes from the German word 'Dokumentation'.