How to evaluate software for ASD-STE100

Software is not necessary, but it helps you

To remember all the rules of ASD-STE100 is not easy, as these examples of approved dictionary words show:

• The word oil is approved as a noun, but not as a verb. The word paint is approved as a noun (rule 1.5.4) and as a verb.
• The word fluid is approved as a noun, but not as an adjective. The word liquid is approved as an noun and as an adjective.
• The word those is approved as a pronoun, but not as an adjective. The word these is approved as an pronoun and as an adjective.

The STE dictionary has more than 1000 unapproved words. Each word has one or more approved possible alternatives.

Because STE is good English, to find nonconformities is not easy.

How to evaluate the term checker for ASD-STE100

People ask, "What is better about the TechScribe term checker compared to other software for a controlled language?" TechScribe cannot answer that question. To evaluate software, you must first specify your requirements. Then, compare the software against your requirements.

To help your team to choose the best software to solve your problems, refer to the Software Evaluation Guide.

To use a term checker for a controlled language, your team must add a project's technical terms to the software. For example, in ASD-STE100 issue 8, the word base is unapproved as a noun and as a verb. Possibly, documentation uses the term base deck. To give a correct evaluation of text, the software must 'know' whether the term is approved or unapproved. "To be effective, they [language checkers] also need to contain your in-house technical names and technical verbs. If your technical names and technical verbs are not in the checker, you will get constant 'unknown word' messages" (www.asd-ste100.org/software.html).

To evaluate the TechScribe term checker without adding project terms, do one of these:

• Deactivate the rules that give warning messages for unknown terms (STE 8, rule 1. 1 writing rule. Use approved words. Unknown term). Possibly, the term checker will give more incorrect warnings ('false positives') than when all the terms are specified, because the term checker does not 'know' the correct part of speech for each unknown term. Deactivate these rules:
• Change all the project nouns, adjectives and verbs in a document to ASD-STE100 approved nouns, adjectives, or verbs. The document will lose its meaning, but you will be able to evaluate the results of the term checker.

A minimum of one person who evaluates the software must have a good knowledge of Simplified Technical English. Without that knowledge, your team will probably struggle to know whether the software finds all errors and ignores all the correct text. Most language checkers for a controlled language give some incorrect warnings. Part of your evaluation is to decide whether the frequency of incorrect warnings is sufficiently low. Refer to ASD-STE100 issue 8.

"No software supporting STE is authorized, certified or endorsed by ASD" (www.asd-ste100.org/software.html).

Select the version that you want

Two versions of the term checker are available. The results that you get from the local files version and the remote files version are the same.

Buy the local files version for these conditions:

• Technical writers are not permitted to use the internet.
• Technical writers do not have a connection to the internet.
• 100% availability is necessary (internet connections can fail).
• Your organization wants a copy of the data files.

Make sure that technical writers want to use ASD-STE100

Before you buy a term checker, make sure that the technical writers in your organization want to use ASD-STE100.

Many technical writers do not want to use a controlled language, because they think that a controlled language restricts their creativity. At the Technical Communication UK Conference in 2010, 39 technical writers were asked whether they use a controlled language such as ASD-STE100. One person lifted his hand. Then, the technical writers were asked who wanted to use a controlled language. The person lowered his hand. Not one person wanted to use a controlled language.

The term checker is different to other software for ASD-STE100

These are the primary differences between the TechScribe term checker and other software for ASD-STE100:

• The term checker uses LanguageTool, which is open-source software. LanguageTool uses Java. Thus, you can use the term checker on all operating systems on which Java is available.
• The design is not a 'black box'. The structure and the methods are explained on this website. The term checker uses rule-based pattern-matching, not statistical methods or 'artificial intelligence'.
• There is no 'vendor lock-in'. The language rules are in XML. Your team can change the rules, or you can buy customization services.
• The term checker is a basic product. It does not have many of the features that the competing enterprise software has.
• The term checker is designed for 'fail-safe' operation. It finds all unknown terms.
• TechScribe's emphasis is on the language problems that technical writers have when they write ASD-STE100 Simplified Technical English. Because the term checker uses LanguageTool, it integrates only with the software that integrates with LanguageTool.
• The term checker does not check grammar. A grammar checker asserts than an error exists. The term checker asserts that no error exists in a sentence.

Some language checkers for ASD-STE100 have the features that follow. The TechScribe term checker does not have these features:

• Reports for managers
• Readability statistics
• Authoring memory
• A grammar checker
• Support for S1000D.

© TechScribe, Sheffield, South Yorkshire. Page updated 2021-10-25