User Tools

Site Tools


training:docs_help_review
Process has been replaced - please report bugs using your Customer Care Portal at https://support.windwardsoftware.com

Windward Software Inc – Help file Review Process defined

This document provides a guide to the review of the Help file and how to use Bugzilla in the process.

Prerequisites You will require a User Name and Password for the Bugzilla application. See your supervisor to obtain this log in information. You will need a query added to your Bugzilla account. See your supervisor to setup this query.

- Open the Bugzilla application in your browser. (bugzilla.windward-ca.com/)

- Log into the Bugzilla application with your User Name and Password.

- Run the DOCSREVIEW query to list the entries that require review.

- Open the first entry in the listing by clicking the number in the left most column.

Look at the last comment in the entry to find the Help Topic that requires review. The comment should contain text similar to the following:

——- Additional Comment #1 From John Daniels 2005-06-08 15:04 ——- Completed.

See Topic: “Floor Plan Payments Report”

Locate the topic in the Help file. In this example, you would open the Help file, click on the Search tab and type in [“Floor Plan Payments Report”] including the double-quotes. See Figure 1

Figure 1: Help file search example The only topic you need to review is the one that matches the search exactly. The Help search may return additional topics however only the topic listed in the Bugzilla entry has been modified.

Review the contents of the topic looking for accuracy of information, grammar, current screen shots etc. If you discover a problem, describe the problem fully the Additional Comments section shown in Figure 2.

Figure 2: The Additional Comments section

Fill in the Time Spent and comment then scroll to the bottom of the entry and select the [Reopen Bug] radio button before clicking [Commit]. An example is shown in Figure 3

Figure 3: Reopen example If you do not find any problems, select [Mark bug as CLOSED] radio button before clicking [Commit].

Repeat these steps for as many entries as possible or until the DOCREVIEW query returns an empty list.

If you discover a problem in a topic other than the one you are reviewing, you will need to create a new Bugzilla entry to initiate a correction. To create a new Bugzilla entry click the New link at the bottom of the listing. See Figure 4.

Figure 4: The New Link

You will see the page shown in Figure 5.

Figure 5: The New Entry Page Click the [Product Documentation] link to create a new entry.

Select the ‘Maintenance’ item in the Components list on the right like Figure 6.

Figure 6: The Component selection

Scroll down the page to enter a full description of the problem. Be sure to include the Topic in which the problem was discovered. When you have finished entering the description and summary, click [Commit] to save the entry. You do not need to worry about any of the other settings or boxes. The department supervisor is responsible for setting the priority and other values.

training/docs_help_review.txt · Last modified: 2022/08/22 13:47 (19 months ago) by kturner