Sunday, November 18, 2012

In search of technical authoring tools?


A checker software does not think in the writer's place. Simplified Technical English training, although only a fraction of the cost of such supposed “full implementation”, achieves 75% of the benefits and results of an approach that includes checker software. Bear in mind that using checker software without proper training will do more harm than good. The tool cannot replace the writer, although it can certainly assist him.


This site is no longer maintained

You may be interested in the following links:
www.shufrans-techdocs.com for all technical documentation and publication needs.
www.asd-ste100.net for Simplified Technical English expertise.
www.asd-ste100.solutions for Simplified Technical English training & consultancy services.

International training workshops can be found here:

Standardisation as a cost reduction strategy


Why standardise?

Standardisation is widely practised in manufacturing to realise economy of scale at the product level. Why not apply standardisation to documentation?

Data standardisation is cost saving by common sense. Injuries, losses and costly legal liabilities can occur as a result of unclear documentation and ambiguous translations. Just like the manufacturing industry makes use of standard components in their product assembly line, Simplified Technical English uses standard vocabulary in the ASD-STE100 specification and consistent industry-/product specific terminology to create documentation. 

The borrowed concept of standardisation in the engineering world when translated into the technical documentation industry is based on standardised terminology and simple grammar rules. The latter for instance, promotes the use of the active voice and simple present tense to clearly identify the doer of a particular action so as to avoid miscommunication and ambiguous translations during the localisation process. In a nutshell, we can draw a parallel between grammar rules and SOPs that both share a common purpose in streamlining processes in a straightforward and objective manner.

How does Simplified Technical English differ from Standard English and how do I know if this is right for my industry?

ASD-STE100 Simplified Technical English (STE) is an international standard that helps to make technical documentation easy to understand. Simplified Technical English standardises vocabulary, grammar and style, while letting users control their specific terminology. Although Simplified Technical English originates from the aerospace and defence industries, it can easily be customised and applied to any other industry, including machinery, automotive, electronics, IT and medical equipment. Major manufacturers and the S1000D standard require the use of ASD-STE100 Simplified Technical English.

Case studies available for reference

Our customer is a manufacturer of mobile X-ray based imaging solutions. They created an operator manual and a service manual in Standard English. This manual is to be translated into 7 other languages.

Before using Simplified English, the manuals had a total word count of 67,300 words. The number of pages was 454. In Simplified English, the word count came down to 49,600 words. The page count was reduced to 406.

Standard English cost calculation (in EUR)*

Word count
Word rate
Target languages
Cost
No match
59,315
0.14
7
58,128.70
Repetition
7,985
0.04
7
2,235.80
Total
67,300


60,364.50

Simplified English cost calculation (in EUR)*

Word count
Word rate
Target languages
Cost
No match
36,515
0.14
7
35,784.70
Repetition
13,085
0.04
7
3,663.80
Total
49,600


39,448.50

The company thus saves almost EUR 21,000 or 35% on the translation of these manuals. For subsequent manuals, the savings would increase further thanks to better re-use and yield from translation memory.

Text in Simplified Technical English is easier to understand and may not even require translation. Where translation is needed, Simplified Technical English helps to drastically reduce translation cost and time-to-market, as it effectively eliminates redundant words and improves consistency.


With the ever increasing number of languages that companies need to deal with, these savings add up quickly. As content in Simplified Technical English is easier to validate, technical writers will be more productive, and fewer iterations and less rework will be required.

For this reason, the time-to-market is reduced by a similar percentage.

See our site www.shufra-consultancy.com for more information.

Editorial note: Based on feedback from readers, we would like to clarify that the cost reduction above is based on statistics from standard commercial memory tools, i.e. re-use on the sentence (segment level). This is brought by a combination of consistent style, vocabulary and terminology.