A brief introduction to Simplified Technical English implementation
1 like782 views
This document discusses Simplified Technical English (ASD-STE100), which was developed to improve the clarity and efficiency of technical documentation across various industries, including aerospace, automotive, and electronics. It outlines the history, structure, and writing rules of STE, and highlights its benefits in reducing confusion, translation costs, and communication issues. The document also emphasizes the importance of training and dictionary building for effective implementation of STE.
A brief introduction to Simplified Technical English implementation
- 1. Shufra Copyright © 2014 by Shufra Ltd. All rights reserved. All trademarks acknowledged.. Simplified Technical English (ASD-STE100) by Ms. Shumin Chen
- 2. Technical documentation is mostly written in English English is the most “global” language However, English has a huge vocabulary (700,000 words) and complex grammar Many words are redundant or ambiguous Consider your audience Copyright © 2014 by Shufra Ltd. All rights reserved. All trademarks acknowledged.. Why Simplified Technical English?
- 3. • Confusion • High translation cost • Translation quality • Time-to-market Copyright © 2014 by Shufra Ltd. All rights reserved. All trademarks acknowledged.. The problems • Ineffective training • Damage to equipment • Safety issues
- 4. Copyright © 2014 by Shufra Ltd. All rights reserved. All trademarks acknowledged.. History of Simplified English 1970: US Federal Government introduces Plain English for communications with the public 1986: European Association of Aerospace (AECMA) & the Aerospace Industries Association of America (AIA) jointly developed Simplified English for aircraft maintenance documentation 2004: AECMA is renamed ASD, Simplified English becomes Simplified Technical English (ASD-STE100)
- 5. Not just an aerospace & defence standard 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. Today, 60% of STE users come from outside of the aerospace and defence sector.
- 6. • Set of 65 writing rules • General vocabulary (approx. 900 words) • List of non-approved words and approved synonyms • Guidelines for customer-specific terms (Technical Names and Technical Verbs) • Most important and universal standard for technical English Copyright © 2014 by Shufra Ltd. All rights reserved. All trademarks acknowledged.. ASD-STE100 Specification
- 7. Electronics examples: Copyright © 2014 by Shufra. All rights reserved. All trademarks acknowledged.. What is Simplified T. English? (1/3) Connecting to a Network The NP3250/NP2250/NP1250/NP3250W comes standard with a LAN port (RJ-45) which provides a LAN connection using a LAN cable. The USB Wireless LAN Unit also provides a wireless LAN connection. To use a LAN connection, you are required to assign an IP address to the projector. For setting the NETWORK, see page 110. NOTE: Some projectors may not have the USB Wireless LAN Unit. If you own a projector without the Wireless LAN Unit installed, and need to present to the projector via a wireless connection, the optional USB Wireless LAN Unit must be installed. With the LAN connection, two features are available: Projector Control and Picture transmission. How to connect to a network The projector includes a LAN port (RJ-45) which provides a wired LAN connection. For a wireless LAN connection, there is a USB wireless LAN unit. To configure the network, see page 110. Note: Some projectors do not include the USB wireless LAN unit. You must install a USB wireless LAN unit to use a wireless connection. The LAN connection includes two features: Projector Control and Picture Transmission.
- 8. Medical equipment examples: Copyright © 2014 by Shufra. All rights reserved. All trademarks acknowledged.. What is Simplified T. English? (2/3) Control panel Both the C-arm stand and the monitor cart have a control panel. The two control panels always show the same screen, enabling you to use them for system operation. Depending on the selected function, other controls (buttons, input boxes, displays, etc.) will appear on the control panel screen. The Vision Center control panel is designed as a touch screen. For system operation, just press the desired button or option directly on the touch screen. Control panel The C-arm stand and the monitor cart each have a control panel screen. These screens show the same control panel. Each panel lets you operate the system. The panels have different controls for different functions. The control panel is a touch screen. To operate the system, touch the correct button or option.
- 9. Aerospace & Defence examples: Copyright © 2014 by Shufra. All rights reserved. All trademarks acknowledged.. What is Simplified T. English? (3/3) Rigging the elevator trim control system a. Loosen travel stop blocks on trim tab cables and disconnect actuator screw from link to trim tab. b. Check cable tension and readjust turnbuckle if necessary. Resafety turnbuckle. If chains and/or cables are being installed, permit actuator screw to rotate freely as chains and cables are connected, set cable tension with turnbuckle, and safety the turnbuckle. c. Rotate trim control wheel full forward (nose down), making sure pointer does not restrict trim wheel movement. If necessary to re-position pointer where it will not restrict trim wheel movement, proceed as follows: (1) Remove control pedestal cover. Refer to paragraph 11-5. (2) Loosen nut at trim wheel pivot shaft. (3) Loosen screws securing chain guard (see figure 9- 4) far enough that trim wheel can be removed. How to adjust the elevator trim control system a. Loosen the travel stop block on the trim tab cables. b. Disconnect the actuator screw that connects the link to the trim tab. c. While you install chains or cables, let the actuator screw turn freely. d. Adjust the turnbuckle to set the correct cable tension. Safety the turnbuckle. e. Turn the trim control wheel fully forward (nose down). If you must move the pointer to let the trim wheel move freely: (1) Remove the control pedestal cover. See paragraph 11- 5. (2) Loosen the nut on the pivot shaft of the trim wheel. (3) Loosen the screws that hold the chain guard (see figure 9-4).
- 10. STE training outline & delivery Day 2 – Writing workshop STE writing rules applied Exercises & review Writing/rewriting instruction Addressing quality improvement issues through consistent and standardised writing methodologies Rewriting exercise & review With own documents Use of checker software Q & A Certificate hand-out Copyright © 2014 by Shufra Ltd. All rights reserved. All trademarks acknowledged.. Day 1 – Classroom training Overview of ASD-STE100 Its development & status Explanation of specification Structure & how to use it STE writing rules Set of 65 writing rules Vocabulary review List of approved words List of approved synonyms Guidelines for customer-specific terms: Technical names & verbs
- 11. • Reduced text volume (typically 25%) • Reduced translation cost (typically 35%): - less text to translate - better yield from translation memory • Fewer change cycles • Improved efficiency • Less downtime • Less cost caused by communication issues Copyright © 2014 by Shufra Ltd. All rights reserved. All trademarks acknowledged.. Cost savings you can expect 0% 20% 40% 60% 80% 100% 120% 140% 160% Terms Translatability Volume Standard English Simplified English
- 12. STE is cross-industry Copyright © 2014 by Shufra Ltd. All rights reserved. All trademarks acknowledged.. Automotive • Patria • Rheinmetall MAN Military Vehicles • Sandvik • SEAT • Volkswagen Aviation • Air Arabia • Boeing • Embraer • Eurocopter • FAA • GMF AeroAsia • Goodrich • Lufthansa Systems • Rolls-Royce Electronics • ABB • Creative • Huawei • Philips • Rohde & Schwarz • Samsung IT • Check Point • Cisco • Microsoft • Radisys • Watchguard Machinery • Black & Decker • Finn-Power • HOMAG • Shikoku Kakoki • Tetra Pak
- 13. FAQ (1/3) Copyright © 2014 by Shufra Ltd. All rights reserved. All trademarks acknowledged. 1) Does STE help writers who have only a limited knowledge of English? Although STE was designed to make it easier for readers to more easily understand technical documentation, we found that writers with English as a second language also benefit from the guidance given in the ASD-STE100 specification, and especially hands-on training.
- 14. FAQ (2/3) Copyright © 2014 by Shufra Ltd. All rights reserved. All trademarks acknowledged. 2) Do I really need to buy checker software & implementation software as well? No, in most cases there is no need for this. Training, although only around 10-15 percent of the cost of such supposed “full implementation”, achieves 75% of the benefits and results of a training- only approach.
- 15. FAQ (3/3) Copyright © 2014 by Shufra Ltd. All rights reserved. All trademarks acknowledged. 2) Can you recommend an STE checker tool that helps our writing team conform to STE writing rules after STE training? No tool automatically corrects sentences to comply with Simplified Technical English. Checker tools help their users write according to STE principles, suggesting revisions and corrections during the writing process. Our recommended tool of choice is the Acrolinx ASD-STE100 solution module. Do send us your enquiries and requirements for us to arrange for an online demonstration of this highly customisable STE checker software. For maximum benefits, you should attend a Simplified Technical English training workshop before you start using a checker tool. The tool cannot replace the writer, although it can certainly assist him!
- 16. Implementation • Training • Dictionary building • Writing / editing • Consultancy Copyright © 2014 by Shufra Ltd. All rights reserved. All trademarks acknowledged..
- 17. Training • Training is necessary to learn the rules, how to apply them in practice and how to avoid common pitfalls • 2 - 3 days on-site or shared classes worldwide • Dedicated training group size up to 12 participants • Use of checker software (optional) • Approaches towards writing, rewriting, updating Copyright © 2014 by Shufra Ltd. All rights reserved. All trademarks acknowledged..
- 18. Dictionary building • Terminology (Technical Names and Technical Verbs) is company-specific and must be established in addition to the general vocabulary • We can do text mining on existing documentation to find company-specific terms • Average size of custom dictionary is approx. 2000 words • STE only allows the use of approved (i.e. documented, unique and unambiguous) words: one word – one meaning • Customer can maintain dictionary Copyright © 2014 by Shufra Ltd. All rights reserved. All trademarks acknowledged..
- 19. STE implementation & consultancy STE editing & proofreading services Technical writing Translation Multilingual documentation DITA & S1000D solutions Our services Copyright © 2014 by Shufra Ltd. All rights reserved. All trademarks acknowledged..
- 20. Thank you For more information, please visit www.shufra-consultancy.com or contact us at info@shufra-consultancy.com Copyright © 2014 by Shufra Ltd. All rights reserved. All trademarks acknowledged.