Testing Phase header image
documentation

Testing Phase

Test the quality of your documentation by having one or more people unfamiliar with the contents read it and provide feedback.

Rock_the_Docs_ShareImage.png

 There are two ideal ways to test your documentation:

Quality Assurance

QA testing is a fantastic way to have your product tested to its limits. This time when a QA tester is working through the product is also a great time to have them run through your documentation. As they set up, use, and modify the product, have them read through the accompanying documentation to make sure it meets their needs.

Early User Testing

If your team has one or more direct users willing to do early testing of your product, what bliss 🙌🏻. When you provide them access to the product, don't give them any form of introduction. Instead, give them your documentation along with the product and see how it works for them. This is a prime way to understand whether you've met the direct needs of your users.

If you don't have a group of users who will do early testing, find one. Direct customer insight in product development is a core tenant of the Agile manifesto. Documentation is a product just as much as software is.

Often testing docs draws out small bits of new information to include, or small adjustments to make. These small changes can play a huge role in reducing support burden in the future.

Embed comments

Next Up...

Learn the basics of creating documentation in any agile framework.

documentation
Steffen Burzlaff Steffen Burzlaff

This is when your team documents what users want and how you plan to deliver it within the product. Use this phase as an opportunity to begin your draft documentation.

documentation
Steffen Burzlaff Steffen Burzlaff
documentation
Requirements Phase

With your draft in hand, you'll begin working with the team to write full documentation. This phase is interesting, because the team is simultaneously building and documenting the product.

documentation
Steffen Burzlaff Steffen Burzlaff
documentation
Development Phase

As part of a great agile process, your documentation is ready for delivery along with your product. Publishing can be handled using one or more approaches, depending on the type of product you make.

documentation
Steffen Burzlaff Steffen Burzlaff
documentation
Delivery Phase
Share this article
Reset Cookies

The following services will be reset and deactivated for you.

  • Typeform:
    We're using Typeform to embed quizzes and surveys into our website. By clicking "Disable all services" you're no longer able to submit quizzes or surveys on our website until accepting the service again.
  • Hyvor Talk:
    We're using Hyvor Talk as a comment tool. Hyvor Talk sets a local storage when activated. By clicking "Disable all services" you're no longer able to post or read comments on our website until accepting the service again.

By clicking "Disable all services" all cookies and local storages related to the services will be removed. Before using them on our website again, you need to accept them.