5 collocation exercises on technical documentation verbs.
0 / 5 completed
1 / 5
Every new API endpoint must be fully ___ before the service is released to partner teams.
An endpoint must be documented — meaning its contract, parameters, and examples must be described in reference material, typically an OpenAPI spec. Document is the standard technical writing verb, as in "well-documented API." Written up, described out, and noted down are informal and imprecise for the comprehensive reference material an API requires. Engineers say "document the endpoint in the spec before release," so documented is the correct form here for producing formal API reference material.
2 / 5
The team will ___ the runbooks with the new incident response procedures before the next on-call rotation.
To update documentation means to revise it to reflect current procedures, configurations, or interfaces. Update is the standard docs verb, as in "update the runbook" and "keep documentation up to date." Fix up, change over, and revise out are informal or not idiomatic for documentation maintenance. Teams say "update the runbook before the rotation handover," so update the runbooks is the correct collocation for revising existing operational documentation.
3 / 5
The team lead will ___ the old v1 setup guide, as it no longer reflects how the system is configured.
To deprecate documentation means to mark it as outdated and direct readers to the current version. Deprecate is the standard docs term, used in "deprecated docs" warnings and banner notices. Delete away removes it entirely without warning, archive out and remove over are informal. Documentation sites show "this page is deprecated — see the v2 guide," so deprecate the guide is the correct collocation for marking documentation as outdated while still making it discoverable with a clear redirect.
4 / 5
The technical writer will ___ the documentation to keep it accurate and aligned with the current codebase.
To maintain documentation means to keep it accurate, up-to-date, and aligned with the current system over time. Maintain is the standard term, as in "maintaining the docs" and "documentation maintenance." Keep up is informal, and hold over and continue out are not real collocations in this context. Engineers say "maintaining docs is as important as maintaining the code," so maintain documentation is the correct collocation for the ongoing effort of keeping reference material current.
5 / 5
Once the old system is fully decommissioned, the team will ___ the legacy documentation for historical reference.
To archive documentation means to move it to a read-only or low-visibility store, preserving it for historical reference without presenting it as current. Archive is the standard content-management term, as in "archived docs" and "archiving obsolete content." Save away, store out, and pack off are informal. Docs platforms offer "archive" functionality, so archive the documentation is the correct collocation for preserving old content in a way that signals it is no longer authoritative.