WordCheck/Project Management
From DPCanadaWiki
What will a PM see?
What a PM will see on the Edit Project page depends partly on whether proofers for that project have used the "Unflag All & Accept" button to make any suggested additions to the project's Good Word List.
There are three "suggestions tools" built into the WordCheck interface to assist PMs in crafting their project Word Lists. Two are tools designated to help with Good Word Lists,
- "Words in the project that WordCheck would currently flag," and
- "Suggestions from proofers,"
and one is designated to help in constructing Bad Word Lists,
- "Words in the project that are in the site's Possible Bad Words file."
Links to the "Suggestions from proofers" tool results will only appear after there has been at least one suggestion made by a proofer. Thus, this label and associated links will never appear until the project has become active.
Right now, the label and links for the "Words in the project that are in the site's Possible Bad Words file" tool will always appear on the Edit Project page, even when it is not applicable, which is when there is no "Possible Bad Words" file for at least one of the project's languages. The list of languages for which a "Possible Bad Words" file exists can be found in the WordCheck FAQ.
More information and sample screenshots of what a PM will see is available on the WordCheck/Project Management/What PMs will see page.
What does a PM have to do? Create a Good Word List for projects.
According to TPTB, the minimum a PM will have to do is create a Good Word List for all active projects, except for in those few cases where a Good Words list would not be appropriate[1].
Once the page files for a project have been loaded, its initial word lists can be created. The steps to create the initial Good Word List for a project are as follows.
- Go to the Edit Project page.
- Scroll down to just below the Good Words text box where you will see the links for the "Words in the project that WordCheck would currently flag" suggestion too.
- Click on the link to Display or Download the results, as you desire. If you are viewing the results online, you can click on the appropriate link to see the results filtered to your desired frequency cutoff point.
- Based on your knowledge of the project, and as simple or as sophisticated an analysis as you want to conduct, determine which words should go on the project's Good Words List.
- Enter the chosen words in the Good Words text box on the Edit Project page, keeping one word per line. While words can be typed directly into the box, copy-and-pasting may be more accurate (less likely to introduce typos into the list).
- Save your changes to the Project Page.
How would a PM create a Bad Word List for projects?
The mechanics of creating a Bad Word List for a project is basically identical to the steps for creating a Good Word List laid out above. The built-in suggestion tool associated with the Bad Word List is entitled "Words in the project that are in the site's Possible Bad Words file[2]." Ideas for project Bad Words can also come from looking at the projects diffs, or even from words suggested for, but rejected from inclusion in, the project's Good Words List.
OK, I understand the mechanics, but how does a PM decide what's a Good or Bad Word in a project?
You may or may not like this answer, but the system has been intentionally designed to allow PMs a great degree of latitude and flexibility in deciding how to decide what specific words to put on the project's word lists.
At its core, the basic analysis is as follows:
- Do I want to put this word on the Good Word list can be analyzed as "do I want this word to never be flagged by WordCheck for proofers?"[3]
- Do I want to put this word on the Bad Word list can be analyzed as "do I want this word to always be flagged by WordCheck for proofers?"
- If your answer is "yes," the word goes on the list, but if the answer is "no," "maybe," or "I don't know," the word should stay off the list.
Different PMs will use different frequency cutoff settings in filtering the suggested results. Some PMs will use a "take time now to save time later" approach, and others are will use a "take a bit less time now and be quite willing to spend a bit more time later" approach.
Some methods, techniques, tools, etc. individual PMs have reported as using include:
- Using guiprep to help look up/verify suggested words in page files.
- Accept suggested words at the nth frequency level which PM knows to be good, and then rely on proofers' suggestions for subsequent additions to the Good Word List
What does a PM have to do with WordCheck after the initial Word List(s) have been created?
The short answer to this is "that's entirely up to you."
The longer answer depends on how your constructed your initial Word Lists in the first place.
Footnotes
1
In the rare case where no flagged words are correct, or where there is no dictionary for the project language(s) then it will be appropriate to leave the Good Words list empty--but only in such rare cases. When this is the case, please leave a note in the Project Comments that the Good Words list has been left blank intentionally.
2
Right now, the label and links for the "Words in the project that are in the site's Possible Bad Words file" tool will always appear on the Edit Project page, even when it is not applicable, which is when there is no "Possible Bad Words" file for at least one of the project's languages. The list of languages for which a "Possible Bad Words" file exists can be found in the WordCheck FAQ. There has been a suggestion that these links not appear when the tool is not applicable to a project, and it is likely that suggestion will eventually be implemented.
3
The Bad Word List "trumps" the Good Word List. Thus, if a word happens to end up on both the project's Good Word List and Bad Word List, the word will be flagged for proofers.
