A
A
AbcEnt032019-09-08 19:27:45
Software testing
AbcEnt03, 2019-09-08 19:27:45

How to arrange documentation testing?

Documentation needs to be tested. The documentation is one of the customer's requirements. I think to issue as a test report, but I do not understand what to describe there.

Answer the question

In order to leave comments, you need to log in

1 answer(s)
D
dollar, 2019-09-08
@dollar

Weird question. The main function of documentation is to explain something. What exactly depends on the type of documentation. If the documentation does not fulfill its purpose, that is, questions remain after reading, then the test is not passed.
I think it is useful for a person verifying this fact to focus on the following questions:

  • What for? Documentation should have a clear purpose so that the reader immediately understands why this documentation is needed. This is kind of obvious, but the author of bad documentation may miss this point.
  • Why? Each item in the documentation should explain why this particular solution was chosen and not another. This is a comparison with other options.
  • Is there any benefit? Documentation should make it clear what will be better than what is already there. If there is proof that the feature will bring money, this is generally chic.

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question