Documentation Checklist


Beta-testing campaigns are addressed to third-party users that are not familiar with the software. The role of the beta documentation is to make things easy for them. Beta documentation should be a subset of the whole software documentation which can be too complex and not adapted to the needs of simple beta testers. The extent and formality of the Beta Documentation Set will depend on the organization and scope of the beta-testing campaign. It should be short and to the point, a quick easy read for beta testers. 

The checklist below describes what a beta documentation should ideally contain. In this checklist the most important point is probably the sted-by-step tutorial.

Introduction

  • Beta test goals and timeline
  • Software overview
  • Assumptions and requirements

Beta scenario(s)

The most important chapter: should be a detailed doc of what to do, and/or links to it, in agile "hands on" mode (must be easy for the tester to setup the environment then start testing immediately). If one can't start within minutes, the campaign is a mess.

  • Step-by-step tutorial(s)

Campaign process

  • Feedback collection process
  • Reward for beta testers

Practical information

  • Software documentation
    (links to relevant software documentation, with more details than in "scenario" chapter)
  • Support contact and/or mailing list details
  • Beta version limitations
  • Link to the GDPR Notice

And while we are at it, here are a few links on "software documentation best practices":

The Reachout project has received funding from the European Union's Horizon 2020 research and innovation programme under grant agreement number 825307.

flagEU.svgThe information in this document is provided “as is”, and no guarantee or warranty is given that the information is fit for any particular purpose. The content of this document reflects only the author`s view – the European Commission is not responsible for any use that may be made of the information it contains. The users use the information at their sole risk and liability.

This wiki is licensed under a Creative Commons 4.0 license
XWiki Enterprise 12.10.3 - Documentation