Technical Writer (QA / Docs) interview questions and answers

8 of 8 questions shown

1. juniorAPI docsHow do you test documentation for a REST API?

   Model answer. Run every sample against a real environment, compare examples with the actual schema, status codes and error format, follow the authentication steps from scratch, and check parameter types and limits and the links. Put runnable samples in CI so they cannot rot.

   Tools: Postman

   I can answer this
2. juniorClarityWhat makes an instruction step testable?

   Model answer. One action per step, the expected result stated, prerequisites listed first, exact UI labels and no ambiguity. Test it by having someone unfamiliar with the product follow the steps without help.

   I can answer this
3. midDocs as codeWhat does docs-as-code mean and which checks do you automate?

   Model answer. Documentation lives in version control, is reviewed through pull requests and built in CI. Automate link checking, style and spelling linting (Vale), tests of code samples, build warnings and validation of the OpenAPI file.

   I can answer this
4. midReleasesHow do you verify release notes are accurate?

   Model answer. Reconcile them with merged tickets and the diff, and test each claimed behaviour. Make sure breaking changes carry migration steps. Check version numbers and remove internal jargon.

   Tools: Jira

   I can answer this
5. midConsistencyHow do you keep terminology consistent across a documentation set?

   Model answer. Maintain a glossary and style guide and enforce them with lint rules. Search for variants of key terms, and take UI strings from the product's string files instead of retyping them.

   I can answer this
6. midContractsHow do you detect drift between an OpenAPI spec and the implementation?

   Model answer. Run a contract tester such as Schemathesis or Dredd against the service in CI and fail on mismatched schemas, undocumented fields and unexpected status codes. Generate reference docs from the spec as the single source.

   Tools: Postman

   I can answer this
7. seniorMeasurementHow do you measure whether documentation works?

   Model answer. Task success in usability tests, time to first successful API call, support tickets deflected, searches with no results and page feedback. Track documentation defects per release like product defects.

   I can answer this
8. seniorVersionsHow do you manage docs for several product versions?

   Model answer. Keep versioned branches or single-source content with conditional blocks, and show deprecation banners. Set canonical URLs and redirects, and test that the version selector lands on the right page.

   I can answer this

No question matches those filters. Clear the search or choose All.