Learn natural collocations for writing, publishing, versioning, and maintaining API documentation.
0 / 5 completed
1 / 5
The backend team was asked to ___ API documentation before the third-party integration went live.
Write API documentation is the natural collocation. Documentation is 'written', not 'built' or 'produced out'. 'Create up' is ungrammatical. While 'build docs' is used informally, 'write docs' is the professional standard.
2 / 5
After completing the authentication endpoints, we need to ___ the updated docs to the developer portal.
Publish API documentation is the standard phrase for making docs publicly available. 'Send out' is used for emails. 'Release out' and 'upload away' are not standard collocations for documentation.
3 / 5
The team uses Semantic Versioning to ___ the API documentation alongside each major release.
Version API documentation means to maintain different docs per API version. This is standard practice with tools like Swagger. 'Number' is used for sequential IDs. 'Label' and 'tag along' don't capture the versioning concept precisely.
4 / 5
Someone needs to ___ the docs regularly to ensure they reflect the latest endpoint changes.
Maintain documentation is the standard technical writing collocation meaning to keep docs current and accurate. 'Look after' is informal. 'Keep up' is ambiguous. 'Service' applies to software systems, not documents.
5 / 5
Before the public API launch, a technical writer was brought in to ___ the documentation for accuracy.
Review documentation is the correct collocation in a professional writing context. A formal review checks completeness, accuracy and clarity. 'Check through' is informal. 'Audit over' and 'inspect all' are not standard phrases.