Skip to main content

write-qa-notes

Capture QA tribal knowledge — environment quirks, known issues, workarounds — as accordion entries on the single apps/docs/docs/QA/common-knowledge/index.md page. This is freeform notes, not test cases (write-test-cases) and not automated test code (write-tests).

Use it when​

  • You've hit something worth remembering next time (a flaky check, an environment-specific behavior, a "looks broken but isn't").
  • You want it discoverable on the docs site later, not buried in a chat or a Slack thread.

What it helps solve​

  • Stops the same gotcha from being rediscovered from scratch by the next person.
  • Keeps tribal knowledge out of people's heads and out of ephemeral chat history.
  • Keeps every note in one shared, searchable page instead of scattering topics across many small files.

See also: Testing, write-test-cases.