Testing approach (admin)

Before giving end-users (responsible for testing) access, the admin must check whether the template is complete, its questionnaire is working as intended and the document output is correct. Your testing strategy will probably be:

Create an ‘all-options’ contract #

Create a contract with as many options included as possible. This can be done automatically:

1. Open the template in the Template Creation Tool and click Edit the template settings.
2. Navigate to the Originals tab.
3. Click Add All options document.

All the variables in the template will be incorporated in the contract as bracketed text. If some Q&A-options would be mutually exclusive, all options – and all suboptions of options, etc. – will be included. Therefore, this all-options contract will contain the entire template.

Alternatively, you could of course generate an all-options document manually by starting a new contract and ticking all boxes and filling in all fields in the questionnaire. Such a document would only include the selected options and might therefore exclude certain others, of course. If you manually create an all-options document, it may be helpful when filling in the questionnaire to put the answers for editable fields between square brackets: that will make it easier to trace them.

Upload originals #

Upload (the inserted variants of) the original model contract. Full users (including administrators) will be able to compare generated contracts in Weagree to the originals. Adding originals is easy:

1. Open the template in the Template Creation Tool and click Edit the template settings.
2. Navigate to the Originals tab.
3. Click Upload document.
4. Select the model contract.
5. Ensure that Template original is selected for Document type.
6. Insert a version number if applicable.
7. Click Upload.

Check simple options in the WYSIWYG editor #

While going through the questionnaire, in simple dropdowns, click all the available options, and check whether they appear in the WYSIWYG underwater screen.

The WYSIWYG underwater screen is reliable in that text which appears there, will also end up in the created Word-document. It means that you do not need to create a document for every Q&A question. Note that due to incompatibility of HTML (webpage text) and MS Word,  the WYSIWYG editor cannot exactly match certain formatting options (e.g. in certain cases, clause indentation).

Compare to originals #

Compare the generated contract against the original and check if everything that had to be in, is indeed included. Sometimes, the instructions in the original document might not have been unequivocal about how options and alternatives were to be automated.

Create a minimal document. Answer a questionnaire in which the options are reduced to a minimum. Compare it to the all-options version and check if there are no left-outs that should be included.

How many documents to create? An automatically generated all-options document will account for all possible variations in the template. This may make it difficult to read, however, if the template is very complex and especially if it incorporates several major variants of a model contract. Determining if the questionnaire is working correctly – inserting the correct text for each variant – can then be difficult as well. In such a case, it may be more practical to manually create an all-options document. If a template contains several ‘global questions’ (the first Q&A questions to appear in the questionnaire), it is recommended that a Word-document is generated for each of the global question-answer options, in any event for the impactful global questions).