Incorrect Help Documentation for Math

 

Summary

When using the OpenOffice.org Math help, the documentation for the Convert function lists some files incorrectly, giving a false file name and file directory.

Application Description

OpenOffice.org is a free office suite that includes a word processor, a spreadsheet creator, and a presentation creator. Math is the spreadsheet component of OpenOffice.org and is used to calculate statistics, create graphs, merge data, and perform other math-data functions.

Test Design

This example demonstrates the use of Specification-based testing (or Spec-based testing). When Spec-based testing, the tester analyzes the program's performance based on what the specifications state.

For this presenation, we are looking at the specifications in the Help documentation, and verifying that Math's Convert function performs as explained in that documentation.

Spec-based testing can be useful for determining the proper function of a program if the tester is unaware of how the program should perform. It is also useful to verify that the program and documentation match each other, such that users will be able to read the documentation to use the program correctly. However, keep in mind that documentation is often out of date or written by people who have not worked with the program directly.

Performing the Test

  1. Open OpenOffice.org Math.
  2. Open the OpenOffice.org Math Help documentation by clicking on Help->Contents from the top horizontal menu:

    Notice in the above picture that we have already selected "CONVERT" in the Search Term box. If we were doing a full range of tests, we might have actually gone through each of the topics listed in the Search Index, but for this presentation we will look exclusively at the Convert function.

  3. The Convert documentation tells us that the settings for this function are contained in a file called calc.xml which is in the {installpath}/share/config/registry/instance/org/openoffice/Office directory:

  4. Let's go find calc.xml by browsing through Windows Explorer.
  5. After getting to the {installpath}/share/config/ directory, we find that there is no folder called registry:

  6. We can use the Windows Find tool to search for calc.xml:

Results/Relevance

It would appear as if our program is incorrect, as the file is not where the documentation stated. However, Math's Convert function works correctly, so therefore either the documentation is out of date or the Convert function is operating without the file (which may have been lost during the install or have become corrupted).

Actually, the documentation is out of date. The convert function now uses a file called calc.xcu, which resides in the {installpath}/share/registry/data/org/openoffice/Office/ directory. So:

Documentation {installpath}/share/config/registry/instance/org/openoffice/Office/calc.xml
Actual File {installpath}/share/registry/data/org/openoffice/Office/Calc.xcu

During updates and minor software changes, it is often the documentation that get's left behind, which creates a massive problem for testers who are testing an application based on the specifications. They may end up testing for components that existed in the product 6 months ago, but have long since been changed. If you plan to have your project team do Spec-based testing (and even if you do not plan to), make sure to keep your documentation as up-to-date as possible to ensure that your testers (and more importantly your users) will know how to use your program.

Similar Tests/Additional Notes

More information about the bug in this presentation can be found on the OpenOffice.org issue tracker site.

Reading the documentation, even if out of date, can often provide a fundamental (and extremely valuable) understanding of what a program does. If you do not have much experience with a program that you are required to test, try reading the documentation first. You most likely will find it much easier to navigate through the program's functions and components.

Configuration Notes

Testing OpenOffice.org's Math v1.1.1 on:

Created 24 June 2004 for the CSTER

All images and written material ©Copyright Sam Oswald 2004

This work is licensed under the Creative Commons Attribution-ShareAlike License.
To view a copy of this license, visit
http://creativecommons.org/licenses/by-sa/2.0/
or send a letter to
Creative Commons, 559 Nathan Abbott Way, Stanford, California 94305,
USA.