Shufra Consultancy: style guides

Showing posts with label style guides. Show all posts

Saturday, March 21, 2015

Woon een 2-daagse workshop bij in Soest om ASD-STE100 te leren

ASD-STE100 Simplified Technical English (STE) is een gecontroleerde taal die wordt gebruikt om technische handleidingen zodanig te schrijven dat ze gemakkelijker en beter worden begrepen door een internationaal publiek, waardoor de veiligheid en efficiency worden verbeterd. STE is veelal een officiële vereiste voor onderhoudshandleidingen in de luchtvaart- en defensiebranche, en kan eenvoudig worden toegepast in alle technische branches en daarbuiten.

STE is geen eenvoudige taal die u kunt leren door middel van zelfstudie. Deze door Shufra Consultancy en Triview gezamenlijk georganiseerde cursus biedt cursisten de mogelijkheid om elke afzonderlijke regel te leren en toe te passen in een praktische context. Mevrouw Shumin Chen zal deelnemers leren hoe zij STE op correcte en doeltreffende wijze kunnen toepassen in de praktijk. Ook zullen enkele fouten die regelmatig worden gemaakt in technisch schrijven en het vaak onjuiste gebruik van algemene STE-schrijfregels worden behandeld.

Cursusoverzicht

Praktisch overzicht van ASD-STE100 Simplified Technical English
Hoe STE zowel native speakers als niet-native speakers Engels helpt
Schrijfregels en de toepassing ervan in de praktijk
Het gebruik van de algemene vocabulaire
Omgaan met branchespecifieke terminologie
Hoe STE wordt gebruikt voor verschillende typen documentatie
De implementatie van STE met minimale verstoring van de lopende productie en bestaande
documentatie
Praktijkoefeningen in STE redactie- en beoordelingswerk

Doelgroep

Compliance managers
CIO, COO, CTO
Klantenservicemanagers
Documentatiebeheerders
Redacteurs
Engineering managers
Ingenieurs en MKB-bedrijven die documentatie schrijven
ILS managers
Maintenance managers
Operation managers
Productmanagers
Projectmanagers
Kwaliteitsmanagers
Veiligheidsmanagers
Technisch schrijvers
Translation managers
Vertalers

Cursusdatum en -locatie
Wij nodigen u graag uit voor onze aanstaande gecertificeerde ASD-STE100 training in Soest op 13 en 14 april 2015. Ook verzorgen wij graag een cursus op maat op uw locatie om in te spelen op uw specifieke behoeften.

Resultaat van de cursus
Onze interactieve cursus, oefeningen en workshop zullen deelnemers leren inhoud te standaardiseren
om:

Efficiënter te schrijven
Doeltreffender te communiceren met een wereldwijd publiek
De operationele veiligheid te verbeteren
Stilstandtijd te reduceren
Modulair schrijven en hergebruik te vereenvoudigen
Teamwerk te vereenvoudigen
Vertalen te vereenvoudigen
Een optimale consistentie te verkrijgen
Ondersteuning tijdens de levenscyclus van een product te optimaliseren
De kosten van het maken en onderhouden van technische publicaties te verlagen

Kwalificaties van de trainer
Mevrouw Chen heeft vele bedrijven ondersteund op het gebied van hun STE- en andere documentatiebehoeften, waar mogelijk op basis van normen. Hoewel STE werd ontwikkeld voor de lucht- en ruimtevaartbranche, en in het bijzonder voor onderhoudsdocumentatie voor vliegtuigen, heeft mevrouw Chen gemerkt dat het zeer zinvol is om deze beginselen ook toe te passen in andere branches en soorten documenten. Er zijn weinig of geen wijzigingen in de specificatie nodig om STE aan te passen aan uiteenlopende branches, van machinebouw tot IT, en van auto's tot medische apparatuur.

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:

http://www.shufrans-techdocs.com/upcoming-ste-training-locations/

Wednesday, February 13, 2013

The value of rules in Simplified Technical English

Rules regulate the choice and use of words, building phrases and sentences, the use of articles, the verb tenses that can be used and (to some extent) the punctuation. Some of the rules are specific to procedural or to descriptive text. Part of the rules is generally known to professional communicators, but the overall set is in general rather nicely balanced while going beyond most corporate and general style guides.

Some examples of rules are:

• Keep procedural sentences as short as possible
(20 words maximum).
• In an instruction, write the verb in the imperative
(“command”) form.
• Keep sentences in descriptive writing as short as
possible (25 words maximum).
• Start a warning or a caution with a simple and
clear command.

Each rule comes with an often lengthy explanation.

If I could only pick one rule that has a lot of positive impact on readability and re-use, it would be rule 1.1, which basically tells us that we can only use approved words (yes, that’s right –every single word we use has to be approved), and that these words can come from three sources: the general approve vocabulary listed in the specification, Technical Names and Technical Verbs. The latter two are determined by the user, based on industry, company and product.

Copyright © 2013 Shufra, LLC. All rights reserved. No part of this article may be reproduced or transmitted in any form or by any means whatsoever without express written permission from the author, except in the case of brief quotations embodied in critical articles and reviews. Please refer all pertinent questions to Shufra Consultancy.

Monday, February 11, 2013

How is STE different from company style guides?

Company style guides often include:

· Writing rules

· Company-specific terminology

· Rules on formatting

STE includes:

· 66 writing rules

· Guidelines on company-specific terminology (nouns and adjectives known as “Technical Names”)

· General vocabulary (approx. 900 approved words as well a large number of commonly used words that are not approved in STE)

The main difference between STE and the average corporate style guide thus is the addition of general vocabulary, while providing for flexibility regarding company- and industry-specific terminology – a very powerful concept that greatly facilitates adaptation to a company’s specific requirements.

As STE was developed by people from different companies (including for example Boeing and Airbus), countries (USA, Canada, various European countries) and professional background (writers, linguists and engineers), the rule set and vocabulary are rather well-balanced rather than to reflect the views of a single person or company. Moreover, the rules and vocabulary were validated against actual content from relevant manuals.

Since development of the specification started some 30 years ago, it has seen regular updates, in part based on change requests from users in the field. The current release is Issue 6, released in January 2013. The specification is maintained by ASD (formerly AECMA), the AeroSpace and Defence Industries Association of Europe.

About the author

Dr. Frans Wijma has a background in electrical engineering and linguistics.

He has been working as a consultant with customers in various industries worldwide and is widely regarded as the leading expert in Simplified Technical English, aviation documentation and multilingual documentation, providing training and consultancy services to customers worldwide. In addition, he is a regular speaker at language and industry events, fluent in 10 languages and a commercial pilot.

Over the years, Frans Wijma was responsible for the development and implementation of STE checker tools for compliance with ASD-STE100 Simplified Technical English (Simplified Technical English, formerly AECMA Simplified English). He has also worked with the checker tools MAXit (Smart Communications), BSEC (Boeing Simplified English Checker) and acrolinx IQ.

Frans Wijma was the project manager for many translation and development programs for customers worldwide, including Boeing, Embraer, Black & Decker, Rolls-Royce and Fuji Heavy Industries.

In 2001, Frans Wijma was presented with the prestigious Pride @ Boeing award in recognition of exceptional performance in supporting the development of the multilingual Longbow Apache IETM for Korea.