How To Be a Tester - WillemSleegers/statcheck-word GitHub Wiki
Thank you for helping us improve the statcheck Word add-in by testing it out! We want to make this as easy for you as possible, so below we provide some useful information about how to get started.
To test the add-in, you need to download a few files. For one, you need a so-called manifest file. This is the file that represents the add-in and will need to be installed on your computer. You should also download our test Word document. This document contains some instructions and examples of statistical tests that can be used to test the add-in.
Unfortunately, GitHub does not let you download individual files very easily, so the best way is to download all the files of this repository. You can do that by going to the Code page of this repository, click on the Code button, and then on 'Download ZIP'. Alternatively, you can click here.
Once the ZIP file is downloaded, unzip it, and navigate to the manifests folder. Here you will find multiple manifest files. The one we want you to use for testing is called 'manifest-statcheck-uvt-test.xml'. Additionally, you can find the test document in the folder called 'doc'.
The next step is to install the manifest file so that Word knows where to find it. This differs depending on whether you use Mac or Windows.
You can find Microsoft's instructions on how to install the manifest file here.
In short:
- Go to
/Users/<username>/Library/Containers/com.microsoft.Word/Data/Documents/
and open the folder called 'wef'. If the folder does not exist, create it with a right-click in the folder and select 'New Folder'. - Move or copy the manifest file into this folder.
- Open Word, or restart Word if it was open.
- In Word, choose Insert > Add-ins > My Add-ins (click on the drop-down menu), and then choose the add-in. It should be titled 'statcheck-uvt-test'.
Installing the manifest file in Windows is a bit more convoluted. Thankfully, Microsoft made a video explaining how to do it, which you can find here. You can also find the written instructions on this page.
In not-so-short:
- Create a folder somewhere on your computer and put the manifest file into this folder.
- Right-click on the folder and select Properties. Then go to the Share tab of the properties window.
- Share the folder; make sure you have Read/Write permissions.
- Once it says that the folder is shared, copy the path to the folder. It should be visible in this window and should look something like
\\willemsleegers\statcheck
. - Open Word and go to File -> Options -> Trust Center -> Trust Center Settings -> Trusted Add-in Catalogs.
- In the Catalog Url box, enter the path to the folder you created.
- Select the checkbox under 'Show in Menu'.
- Choose OK to close the settings window and restart Word.
- Open Word again and go to Insert -> My Add-ins. Here, choose SHARED FOLDER at the top of the Office Add-ins dialog box.
- Select the add-in and choose Add to insert it. The add-in should be titled 'statcheck-uvt-test'.
You have now, hopefully successfully, installed the add-in. This means you can start to test out the add-in. Please see the section below for some instructions on what to pay attention to and what to do in case you find a bug, missing feature, or anything you'd like to comment on.
We are primarily interested in the functionality of the add-in. In other words, does it work? Examples of possible bugs include:
- Error messages
- Non-functional UI elements (e.g., clicking on a button doesn't do anything)
- Incorrect results (e.g., statcheck says something is inconsistent but it actually is).
If you find any of these bugs, please report them to us (see below). You can start your testing with a test document we created. You can find this document in the 'doc' folder of this repository (which you probably downloaded in a previous step).
After testing out the test document, you can also test the add-in with some of your own manuscripts. Please note that statcheck does not detect all statistics. This means it is not necessarily a bug that statcheck does not detect a particular line of statistics. For example, results that are not reported in APA style are not detected by design (for details on what statcheck can and cannot detect, see the manual). If you think statcheck should be able to detect it, please let us know.
Besides testing whether the add-in works correctly, we are also interested in whether the add-in is easy to use. Is it clear how you should use the add-in? Is the output clear? Is it clear where to find the information you need? Is it clear what each button does? If you think something is not clear and can be improved, please let us know.
Finally, we are interested in whether the add-in looks nice. Admittedly, we are not very great at UI design, but if you have any concrete suggestions about how to improve the looks of the add-in, we would love to know.
In summary, we are interested in the following questions:
- Does the add-in work correctly?
- Is it easy to use?
- Does it look nice?
If you have feedback about any of these issues, please let us know.
If you found a bug or if you have other types of feedback you want to share with us, please create an issue here in GitHub.
Creating an issue is fairly easy:
- Go to the Issues page here on GitHub
- Check if your issue is already among the reported issues. If not, click on 'New Issue' to report yours.
- When you create an issue, please report the necessary steps to reproduce the issue if possible and if applicable. Let us know what you expected to see and what happens instead. Or, if you simply have some feedback to share with us, also feel free to make an issue.
That's it! We'll get notifications about each issue and we'll work on addressing them right away.