How to test documentation. Simple algorithm.

Introduction

  • does it meet the requirements?
  • fit the purpose?
  • what defects (bugs) are there?

Documentation testing algorithm

  1. preparation / planning,
  2. test design,
  3. running tests,
  4. reporting,
  5. final actions (optional).
  1. for what purpose the document is created, its official definition,
  2. what mandatory information should it contain,
  3. what information is additional, but it would be nice to have,
  4. we find examples on the Internet, from a personal observation.
  1. we include in it generally accepted requirements in the company,
  2. we select suitable best practices from the vastness of the network,
  3. if there are any ideas for potential defects, write it down.
  1. read, check the execution of the Checklist items.

Example of testing requirements

  • summary — short title,
  • description — description of the upcoming work,
  • user story — type of business requirement in spoken language, used in Agile,
  • acceptance criteria are the criteria that a job must meet in order to be accepted by a customer.
  • use cases — prescribed scenarios for using the system with new functionality,
  • release number — the number of the release for which it is being prepared,
  • epic — the main ticket that groups others,
    etc.
  • user story is a small isolated unit of functionality that can be demonstrated,
  • user story has the format As a < type of user >, I want < some goal > so that < some reason >,
  • ticket fits the sprint goals,
  • the description of the functionality is clear
    (for example, there are no unknown terms, slang),
  • acceptance criteria are testable
    (for example, the system should work stably all year round or the interface should be user-friendly — not testable criteria),
  • the functionality does not depend on other functionality in the sprint
    (or the dependency is specified),
  • the requirements for the new interface are indicated,
  • functionality is prioritized,
  • the new functionality does not contradict, it is consistent with the existing one.

Conclusion

--

--

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store