Say it like this
- Check the documentation for more details
- We need to improve our documentation
- The documentation is out of date
Use it at work
Asking for it
- Is there documentation for this API?
- Can you add documentation for the new config options?
In a code review
- Please update the documentation with this change.
- The documentation says the field is optional, but it isn't.
Planning
- Let's make documentation part of the definition of done.
- Documentation is out of date for the deploy process.
Don't say this
Documentation is a noun. Use 'document' as the verb. 'We need to create documentation for this feature' also works.
Practice
Try it
4 quick exercises
1. Your team completed a new feature. What do you say?
2. The old _______ for the payment system is completely outdated and confusing.
3. Which sentence uses 'documentation' incorrectly?
4. Rewrite this in natural tech English: 'We have to write down all the information about how this system works so people can read it later.'
Say it out loud
Phrase 1 of 3
"Check the documentation for more details"
We don't save your recording. The word check uses your browser's speech recognition.
More about documentation
Real examples(3)
- in a standup
"I spent yesterday updating the API documentation so other teams can integrate with our service."
- in a code review
"This function is complex—we should add better documentation explaining what parameters it expects."
- in a team meeting
"Our documentation hasn't been updated in six months. Let's make it a priority this sprint."
More mistakes(2)
Handle with care. Do not use as a verb form like 'to documentation' — use 'to document' instead. Documentation is a noun referring to written materials.
- ✕The documentation are unclear.✓The documentation is unclear.
Documentation is an uncountable noun and takes the singular verb 'is', not 'are'.
- ✕I read a documentation about microservices.✓I read the documentation about microservices. OR I read a guide about microservices.
Use 'the documentation' (specific collection) or use a countable noun like 'guide' or 'article' with 'a'.
Other forms(3)
- documentation noun
"The documentation for this API is very thorough."
- document verb
"Please document all the changes you made to the codebase."
- documented adjective
"The documented requirements are in the specification file."
Often used with(5)
- write documentation · Used to describe creating or authoring documentation for a project or system
- update documentation · Used when documentation needs to be revised or kept current with code changes
- documentation string · Code comments or docstrings that explain functions or modules (often abbreviated as 'docstring')
- technical documentation · Detailed documentation aimed at developers and engineers (as opposed to user documentation)
- missing documentation · When required documentation has not been written yet
Similar words(4)
- documentation string (docstring) · Refers specifically to inline code comments that explain what code does
- guide · More general; can refer to one document whereas documentation is a collection
- manual · Instruction document for users; more specific than the broad term documentation
- specification · Detailed requirements document; narrower scope than documentation
Opposites(2)
- undocumented
- lack of documentation
Questions(5)
- What does documentation mean in software engineering?
- Documentation refers to written materials that explain how software works, how to use it, or how to maintain it. This includes README files, API guides, code comments, user manuals, and architecture diagrams. Good documentation is essential for helping team members understand code, onboarding new developers, and supporting end users.
- How do you use documentation in a sentence at work?
- Common examples: 'We need to update the documentation before release,' 'Have you checked the documentation for this library?', 'Poor documentation makes it hard for new hires to contribute,' or 'The documentation explains all the parameters for this function.' Remember that documentation is a noun, so use 'document' if you need a verb form.
- Is documentation formal or informal?
- Documentation can be both formal and informal depending on its purpose. Technical documentation for enterprise systems is usually formal and detailed. Internal team documentation or inline code comments might be more casual. The key is that documentation should be clear, accurate, and easy to understand for its intended audience.
- Why is documentation important in tech companies?
- Documentation reduces onboarding time for new team members, decreases support tickets and questions, makes code maintenance easier, improves collaboration between teams, and serves as a reference for future developers who may not have been part of the original project. Many companies treat documentation as part of the development process itself.
- What is the difference between documentation and code comments?
- Code comments (or docstrings) explain specific functions or lines of code within the source file itself. Documentation is a broader collection of written materials that explain the overall system, how to use it, how to set it up, and how different components interact. Documentation usually exists outside or separate from the code itself.
