You are here: Development Standards > Quality Assurance > Design Phase > Testing Documentation

# Testing Documentation

One of the steps in the quality assurance process is to check the documentation. You can often do this between test rounds. Check the following items:

- consistency
- content and clarity
- sample data is correct
- sample reports use correct format and data, and that they foot and cross-foot
- menu samples are correct−correct order and copyright information
- screen samples use correct field names and sample data
- worksheets use correct field names
- field descriptions use correct field names

Run the software as you read the documentation to make sure that it works as the documentation states. Don’t rely on your memory of how the software works.

Keep in mind that the documentation is for a user. Will the user be able to understand and follow the information? Does it make sense? Does it contain pertinent information? Does it answer the questions that come to mind?

When you test application upgrades and data file conversions, follow the instructions in the user’s guide. It is important to know that the upgrade or conversion works as expected and that the user has enough information to perform it and maintain the integrity of his company’s data.

Always look at the instructions from the user’s perspective. In addition to checking that the user is able to perform the upgrade or conversion, check that the user has enough information to start up and run the software. For instance, a data file conversion may convert existing data, but the user may also have to add fields in the file before he can run the software for daily use. The user must have enough information about what is changed, added, replaced or removed.

Different users have different installations. The instructions should be specific, but general enough to fit most installations. Since other applications are often upgraded and converted at the same time, the order of installing or converting applications should be documented where necessary.

The documentation must contain backup instructions to protect the user’s data and system. They should be simple and clear to make the upgrade or conversion process as easy as possible.

During the testing phase, you need to hold meetings with the writer and development personnel to discuss issues and areas of concern. Raise the issues as you find them so that all involved parties have enough time to address them. Give the writer copies of the QATRs or of the QATR database report so that he can review the QATRs for potential documentation issues.