Atlas › 24 Technical Writing for QA › QA Wiki and Runbooks☰ Read as one page
QA Wiki and Runbooks
6.1Building a Knowledge Base That Your Team Actually UsesThe difference between a useful QA knowledge base and a graveyard of outdated documents is not the tool you use -- it is the discipline you…6.2Building a QA Knowledge BaseNot everything needs to be documented. Over-documentation is as harmful as under-documentation because it creates noise that obscures the…6.3Runbooks for Common QA TasksA runbook is a step-by-step procedure for a specific task. Unlike a guide (which explains concepts), a runbook is a checklist that someone…6.4Troubleshooting GuidesTroubleshooting guides document common issues and their solutions. They save hours of debugging by capturing solutions that would otherwise…6.5Decision LogsDecision logs record why certain choices were made. They are invaluable when a new team member asks "why do we do it this way?" or when the…6.6Searchability and DiscoverabilityA knowledge base that nobody can find information in is useless. Invest in discoverability.6.7Wiki Maintenance: Preventing Documentation RotDocumentation rot is the gradual accumulation of outdated, inaccurate, and irrelevant content that makes the entire knowledge base…6.8Tools Comparison6.9Hands-On Exercise1. Audit your current QA knowledge base. Create an inventory of what exists, what is outdated, and what is missing. 2. Write one runbook…