How customers use the term checker for ASD-STE100

People from these organizations tell you how they use the term checker for ASD-STE100:

Didsbury Engineering, UK

By Steve Fanning at Didsbury Engineering.

Background

I am the sole technical author currently working for Didsbury Engineering at our site in Handforth near Stockport (where approximately 35 people work). The main function of our business is to provide lifting and handling equipment to customers in various industry sectors. My primary role is to produce and maintain the manuals for all of our products, most of which are mechanical engineering systems. Didsbury Engineering has recently become a part of the larger MEL Group.

Problem solved with the TechScribe term checker for STE

Some of our customers place requirements for manuals to be written using ASD Simplified Technical English. So far we have agreed with these customers that this requirement will be considered satisfied if their own human STE experts consider the documents to be written in sufficiently simple English. A bit informal, but we simply aren't big enough to purchase an expensive suite of software tools to produce documents that are in some way demonstrably compliant with ASD-STE100.

In this context, where use of STE is necessary, the TechScribe term checker for STE helps in two ways:

  1. By analysing individual paragraphs of text and highlighting potential issues, so that I can make changes as necessary until the text better complies with STE.
  2. Its suggestions help improve my own technical writing (which affects not only those manuals for which STE is a requirement).

Workflow

I produce any new manual of significant size using Adobe FrameMaker. However, some legacy documents requiring maintenance are in Microsoft Word format. My normal workflow is to develop the text in the relevant publishing software and then to analyse that text in the term checker, a few paragraphs at a time. The text of the paragraphs is copied into the term checker, edited as necessary and then copied back to the relevant publishing software.

Anders & Szeifert, Germany

By Bernhard Szeifert at Anders & Szeifert.

Background

Als freiberufliche technische Redakteure schreiben wir Handbücher und Onlinehilfen für Software. Unsere Zielgruppen sind Anwender und Administratoren. Einige unsere Kunden sind im internationalen Umfeld tätig und benötigen englische Anleitungen für Nichtmuttersprachler.

Bei unseren Auftraggebern handelt es sich um Institute und Industrieunternehmen, für die wir englische Anleitungen nach dem STE Standard und deutsche Anleitungen schreiben.

Lösungen mit dem TechScribe term checker für STE

Vor allem in großen Instituten arbeiten wissenschaftliche Mitarbeiter aus der ganzen Welt. Das Sprachniveau für englisch ist sehr unterschiedlich. In diesem Fall schreiben wir die Dokumentation in Anlehnung an STE und garantieren damit eine einfache und korrekte englische Sprache. Zudem hat jeder Kunde hat eine eigene Terminologie, die wir ebenfalls mit dem TechScribe term checker kontrollieren.

Wir setzen den TechScribe term checker für zwei Lösungen ein:

  1. Die Prüfung auf die bestmögliche Umsetzung der STE-Regeln.
  2. Die Prüfung auf die kundenspezifische Terminologie, die nichts mit STE zu tun hat.

Workflow

Während wir die Texte erstellen, schreiben wir die auftretenden technischen Namen und Verben, sowie die spezielle Terminologie des Kunden, in die dafür vorgesehenen Dateien. Aus unserem Content-Managementsystem produzieren wir eine Worddatei, die als Textdatei abgespeichert wird. Die Textdatei wird in den TechScribe term checker eingelesen. Danach werden die angezeigten Fehler abgearbeitet und nicht relevante Regeln abgeschaltet, um die Trefferzahl zu minimieren. Parallel werden die Verbesserungen im Content-Managementsystem eingepflegt.

See also

Case study: text simplification for shipping procedures

RSS feed