@cpf oqtg achieving clarity in documentation with ... · achieving clarity in documentation with...
TRANSCRIPT
![Page 1: @CPF OQTG Achieving clarity in documentation with ... · Achieving clarity in documentation with Simplified Technical English ... easily understand technical documentation, we found](https://reader034.vdocuments.mx/reader034/viewer/2022043005/5f8b5b642998a321432f8bf7/html5/thumbnails/1.jpg)
Achieving clarity in documentation with Simplified Technical English30 June 2016, Shenzhen, China
![Page 2: @CPF OQTG Achieving clarity in documentation with ... · Achieving clarity in documentation with Simplified Technical English ... easily understand technical documentation, we found](https://reader034.vdocuments.mx/reader034/viewer/2022043005/5f8b5b642998a321432f8bf7/html5/thumbnails/2.jpg)
• Principal ASD-STE100 Simplified Technical English subject matter expert & consultant
• Working with international standards since 2006 • Conducts on-site and open technical writing
workshops worldwide
Speaker’s background
![Page 3: @CPF OQTG Achieving clarity in documentation with ... · Achieving clarity in documentation with Simplified Technical English ... easily understand technical documentation, we found](https://reader034.vdocuments.mx/reader034/viewer/2022043005/5f8b5b642998a321432f8bf7/html5/thumbnails/3.jpg)
Your business requirements
Lower cost Shorten
time-to-marketDecrease
dependence on suppliers
![Page 4: @CPF OQTG Achieving clarity in documentation with ... · Achieving clarity in documentation with Simplified Technical English ... easily understand technical documentation, we found](https://reader034.vdocuments.mx/reader034/viewer/2022043005/5f8b5b642998a321432f8bf7/html5/thumbnails/4.jpg)
• Technical documentation is mostly written in English • English is the most “global” language • English is usually the source language for translations
Why English?
![Page 5: @CPF OQTG Achieving clarity in documentation with ... · Achieving clarity in documentation with Simplified Technical English ... easily understand technical documentation, we found](https://reader034.vdocuments.mx/reader034/viewer/2022043005/5f8b5b642998a321432f8bf7/html5/thumbnails/5.jpg)
1. Confusion 2. High translation costs 3. Translation quality 4. Time-to-market 5. Ineffective training 6. Damage to equipment 7. Safety issues
Problems with Standard English
![Page 6: @CPF OQTG Achieving clarity in documentation with ... · Achieving clarity in documentation with Simplified Technical English ... easily understand technical documentation, we found](https://reader034.vdocuments.mx/reader034/viewer/2022043005/5f8b5b642998a321432f8bf7/html5/thumbnails/6.jpg)
“Round the sides of the round cap. If it then turns round and round, as it circles round the casing, another round of checks is necessary.”
Sounds English?
![Page 7: @CPF OQTG Achieving clarity in documentation with ... · Achieving clarity in documentation with Simplified Technical English ... easily understand technical documentation, we found](https://reader034.vdocuments.mx/reader034/viewer/2022043005/5f8b5b642998a321432f8bf7/html5/thumbnails/7.jpg)
History of STE
1970: US Federal Government introduced Plain English for
communications with the public
1982: European Association of Aerospace (AECMA) develops Simplified English for aircraft maintenance documentation
2004: AECMA is renamed ASD, Simplified English becomes Simplified
Technical English (ASD-STE100)
![Page 8: @CPF OQTG Achieving clarity in documentation with ... · Achieving clarity in documentation with Simplified Technical English ... easily understand technical documentation, we found](https://reader034.vdocuments.mx/reader034/viewer/2022043005/5f8b5b642998a321432f8bf7/html5/thumbnails/8.jpg)
STE is cross-industry
Automotive • Patria • Rheinmetall MAN
Military Vehicles • Sandvik • SEAT • Volkswagen • FNSS Defense
Systems
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
![Page 9: @CPF OQTG Achieving clarity in documentation with ... · Achieving clarity in documentation with Simplified Technical English ... easily understand technical documentation, we found](https://reader034.vdocuments.mx/reader034/viewer/2022043005/5f8b5b642998a321432f8bf7/html5/thumbnails/9.jpg)
What is STE? • 65 writing rules • General vocabulary • Customer-specific terms
• One word for every meaning • A list of approved, and non-approved words • Guidelines for customer specific terms
![Page 10: @CPF OQTG Achieving clarity in documentation with ... · Achieving clarity in documentation with Simplified Technical English ... easily understand technical documentation, we found](https://reader034.vdocuments.mx/reader034/viewer/2022043005/5f8b5b642998a321432f8bf7/html5/thumbnails/10.jpg)
Benefits of STE • Standardised way of writing • Consistency on word, phrase and sentence levels
Quality improvement • Cost savings • Time savings due to less rework or editing • Provide accurate information to the reader • Facilitate re-use and Content Management • Cheaper, faster and better translations
![Page 11: @CPF OQTG Achieving clarity in documentation with ... · Achieving clarity in documentation with Simplified Technical English ... easily understand technical documentation, we found](https://reader034.vdocuments.mx/reader034/viewer/2022043005/5f8b5b642998a321432f8bf7/html5/thumbnails/11.jpg)
• Only use simple verb tenses. • For technical documentation, only six tenses are needed.
• When you give an instruction, use the imperative form of the verb.
• ‘Remove the plug.’, vs. ‘The plug ought to be removed.’ • Be direct • Make sure that everyone understands who is required to
take which action at which point in time.
Some of the rules
![Page 12: @CPF OQTG Achieving clarity in documentation with ... · Achieving clarity in documentation with Simplified Technical English ... easily understand technical documentation, we found](https://reader034.vdocuments.mx/reader034/viewer/2022043005/5f8b5b642998a321432f8bf7/html5/thumbnails/12.jpg)
Optimising your technical content
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.
Medical equipment
![Page 13: @CPF OQTG Achieving clarity in documentation with ... · Achieving clarity in documentation with Simplified Technical English ... easily understand technical documentation, we found](https://reader034.vdocuments.mx/reader034/viewer/2022043005/5f8b5b642998a321432f8bf7/html5/thumbnails/13.jpg)
Cost savings you can expect
• Reduced text volume (typically 25%, up to 80%) • Reduced translation cost (typically 35%): • Fewer change cycles • Improved efficiency • Less downtime • Fewer communication issues
![Page 14: @CPF OQTG Achieving clarity in documentation with ... · Achieving clarity in documentation with Simplified Technical English ... easily understand technical documentation, we found](https://reader034.vdocuments.mx/reader034/viewer/2022043005/5f8b5b642998a321432f8bf7/html5/thumbnails/14.jpg)
FAQsDoes 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.
![Page 15: @CPF OQTG Achieving clarity in documentation with ... · Achieving clarity in documentation with Simplified Technical English ... easily understand technical documentation, we found](https://reader034.vdocuments.mx/reader034/viewer/2022043005/5f8b5b642998a321432f8bf7/html5/thumbnails/15.jpg)
FAQsDo 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 an approach that includes software. Software without proper training, however, will do more harm than good. A well-trained writer does not need checker software.
![Page 16: @CPF OQTG Achieving clarity in documentation with ... · Achieving clarity in documentation with Simplified Technical English ... easily understand technical documentation, we found](https://reader034.vdocuments.mx/reader034/viewer/2022043005/5f8b5b642998a321432f8bf7/html5/thumbnails/16.jpg)
Your STE journey
Training
Writing/ editing
Consultancy Dictionary building
![Page 17: @CPF OQTG Achieving clarity in documentation with ... · Achieving clarity in documentation with Simplified Technical English ... easily understand technical documentation, we found](https://reader034.vdocuments.mx/reader034/viewer/2022043005/5f8b5b642998a321432f8bf7/html5/thumbnails/17.jpg)
Your STE journey - consultancy
• STE implementation & consultancy • STE editing & proofreading services • STE continuous improvement
Consultancy
![Page 18: @CPF OQTG Achieving clarity in documentation with ... · Achieving clarity in documentation with Simplified Technical English ... easily understand technical documentation, we found](https://reader034.vdocuments.mx/reader034/viewer/2022043005/5f8b5b642998a321432f8bf7/html5/thumbnails/18.jpg)
Thank you
For more information, please visit www.shufrans-techdocs.com
www.asd-ste100.solutions www.asd-ste100.net
Or contact us at: [email protected]