25
This document and its content is the property of Etteplan. It shall not be communicated to any third party without the owner’s written consent . © All rights reserved. September 26-28, 2016 S1000D User Forum, Seville Name of presenter: Rank/title of presenter: Company/organization: Host (on behalf of ASD): Spanish Association for Defence, Security and Space Technology Companies (TEDAE) Simplified Technical English – ASD-STE100 As part of an S1000D or ATA iSpec2200 implementation Berry Braster Sales Director, Technical Documentation Services

Simplified Technical English as part of an

  • Upload
    votuyen

  • View
    271

  • Download
    6

Embed Size (px)

Citation preview

Page 1: Simplified Technical English as part of an

This

doc

umen

t and

its

cont

ent i

s th

e pr

oper

ty o

f Ette

plan

. It

shal

l not

be

com

mun

icat

ed to

any

third

par

ty w

ithou

t the

ow

ner’s

writ

ten

cons

ent .

© A

ll rig

hts

rese

rved

.

September 26-28, 2016 S1000D User Forum, Seville

Name of presenter: Rank/title of presenter: Company/organization:

Host (on behalf of ASD): Spanish Association for Defence, Security and Space Technology Companies (TEDAE)

Simplified Technical English – ASD-STE100

As part of an S1000D or ATA iSpec2200 implementation

Berry Braster Sales Director, Technical Documentation Services

Page 2: Simplified Technical English as part of an

This

doc

umen

t and

its

cont

ent i

s th

e pr

oper

ty o

f Ette

plan

. It

shal

l not

be

com

mun

icat

ed to

any

third

par

ty w

ithou

t the

ow

ner’s

writ

ten

cons

ent .

© A

ll rig

hts

rese

rved

.

Specialist in engineering, embedded systems, IoT and technical publication solutions and services; established in 1983 2500+ employees, 450 of which are documentation specialists Global operations in Finland, Sweden, Netherlands, Germany,

Poland, USA and China ISO 9001, ISO 14000, and ISO 13485 certified Shares in NASDAQ OMX Helsinki Ltd. (ETT1V)

2016-09-27/28 Simplified Technical English as part of an S1000D or ATA iSpec 2200 Implementation 2

About Etteplan

Page 3: Simplified Technical English as part of an

This

doc

umen

t and

its

cont

ent i

s th

e pr

oper

ty o

f Ette

plan

. It

shal

l not

be

com

mun

icat

ed to

any

third

par

ty w

ithou

t the

ow

ner’s

writ

ten

cons

ent .

© A

ll rig

hts

rese

rved

.

Language Support: IETMs for Boeing Apache, Chinook, C130

Patria vehicle (Finland) Sperwer unmanned aircraft (France) Stinger Launcing System for Fennek vehicle

(Turkey) MTCS training system for SAAB (Sweden) MOGOS system (Netherlands) Weapon systems, including Browning .50 M2 QCB,

MINIMI , Pantserfaust, Stinger, VLAST, C7, C8, LOAWNLD

Automotive projects, including Broshuis, Aarding AD, Aarding trucks, Intercom equipment (Netherlands)

Leopards A5 and A6 for Wegmann (Germany) Unmanned submarine (Germany) John Deere heavy lifting equipment, translation

manuals to Arabic (US/Iraq) Multiple ASD-STE100 projects for Navy (US),

Gulfstream, Rolls-Royce, MBDA, BAE Systems, Fokker, Airbus, EADS, Boeing, SAAB, L-3, American Airlines, Qatar Airways, AirFrance | KLM and more

Bofors (BAE Sweden) KMW (PRTL) Hydrokran (Switzerland) Colt (Canada) Diemaco Rafael (Israel) GILL MRAT FN Herstal (Belgium) LL Launcher and .50 Conteno (Belgium) special containers Selex (Germany) patriot communication system Caru (Netherlands) special containers Elbit (translations) Sun Test Systems MOOG (actuator) SIM Industries (Lockheed Martin) Rheinmetall (Boxer project)

Tech Pubs and Engineering Expertise

2016-09-27/28 Simplified Technical English as part of an S1000D or ATA iSpec 2200 Implementation 3

Page 4: Simplified Technical English as part of an

This

doc

umen

t and

its

cont

ent i

s th

e pr

oper

ty o

f Ette

plan

. It

shal

l not

be

com

mun

icat

ed to

any

third

par

ty w

ithou

t the

ow

ner’s

writ

ten

cons

ent .

© A

ll rig

hts

rese

rved

. Simplified Technical English (as part of an S1000D or ATA ISpec 2200 implementation), what does it entail?

2016-09-27/28 Simplified Technical English as part of an S1000D or ATA iSpec 2200 Implementation 4

Page 5: Simplified Technical English as part of an

This

doc

umen

t and

its

cont

ent i

s th

e pr

oper

ty o

f Ette

plan

. It

shal

l not

be

com

mun

icat

ed to

any

third

par

ty w

ithou

t the

ow

ner’s

writ

ten

cons

ent .

© A

ll rig

hts

rese

rved

.

• Information standards for aviation maintenance

• Recommended specs for content, structure and deliverables to meet communication requirements of aircraft technical information

• Objective is to: – Minimize cost and effort expended by operators and OEMs – Improve information quality and timeliness – Ensure that manufacturers provide data that meets the airline operational

needs

ATA iSpec 2200

2016-09-27/28 Simplified Technical English as part of an S1000D or ATA iSpec 2200 Implementation 5

Page 6: Simplified Technical English as part of an

This

doc

umen

t and

its

cont

ent i

s th

e pr

oper

ty o

f Ette

plan

. It

shal

l not

be

com

mun

icat

ed to

any

third

par

ty w

ithou

t the

ow

ner’s

writ

ten

cons

ent .

© A

ll rig

hts

rese

rved

.

S1000D

2016-09-27/28 Simplified Technical English as part of an S1000D or ATA iSpec 2200 Implementation 6

Page 7: Simplified Technical English as part of an

This

doc

umen

t and

its

cont

ent i

s th

e pr

oper

ty o

f Ette

plan

. It

shal

l not

be

com

mun

icat

ed to

any

third

par

ty w

ithou

t the

ow

ner’s

writ

ten

cons

ent .

© A

ll rig

hts

rese

rved

.

• Inability to deliver the required technical documentation

• Preference given to your competitors • Not qualifying for tender opportunities • Losing supplier status

With compliant data delivery you can: • Further optimize the delivery of technical documentation • Maintain compliance as a Supplier • Access new industries • Be first to market

What this may mean to you

2016-09-27/28 Simplified Technical English as part of an S1000D or ATA iSpec 2200 Implementation 7

Page 8: Simplified Technical English as part of an

This

doc

umen

t and

its

cont

ent i

s th

e pr

oper

ty o

f Ette

plan

. It

shal

l not

be

com

mun

icat

ed to

any

third

par

ty w

ithou

t the

ow

ner’s

writ

ten

cons

ent .

© A

ll rig

hts

rese

rved

.

What problems does STE solve?

• Various levels of technical skills • Risks of misunderstandings • Liability for faulty or incomplete

information • Shorter response times

• Information is becoming more complex

• Massive volumes of maintenance information

• Geographically separated service centers

• Non-native speakers or inexperienced maintenance personnel

2016-09-27/28 Simplified Technical English as part of an S1000D or ATA iSpec 2200 Implementation 8

Page 9: Simplified Technical English as part of an

This

doc

umen

t and

its

cont

ent i

s th

e pr

oper

ty o

f Ette

plan

. It

shal

l not

be

com

mun

icat

ed to

any

third

par

ty w

ithou

t the

ow

ner’s

writ

ten

cons

ent .

© A

ll rig

hts

rese

rved

.

International Civil Aviation Association (ICAO)

“Standardization of language used by maintenance personnel has become increasingly necessary because of substantial changes in maintenance practices in the past 20 years, including: Expansion of the role of computers in the maintenance environment; Fewer translations of documents from English to a native language; Increased use of manufacturer-generated standardized training material (in English); More alliances among airlines, many of which are in countries that have no common

language; and An increasingly mobile, multicultural work force”

2016-09-27/28 Simplified Technical English as part of an S1000D or ATA iSpec 2200 Implementation 9

Page 10: Simplified Technical English as part of an

This

doc

umen

t and

its

cont

ent i

s th

e pr

oper

ty o

f Ette

plan

. It

shal

l not

be

com

mun

icat

ed to

any

third

par

ty w

ithou

t the

ow

ner’s

writ

ten

cons

ent .

© A

ll rig

hts

rese

rved

.

• 2009: a Bond Super Puma AS332L Mark II helicopter crashed in the North Sea, killing 14 oil workers as well as two pilots. 2014: The report blamed the mechanical problems on failed maintenance.

• 2005: Chalk’s Flight 101 crashed shortly after takeoff, killing everyone on board. The cause was traced back to metal fatigue—and a crack in the plane’s wing that was discovered but never properly fixed.

• 2000: Alaska Airlines Flight 261 nose-dived into the Pacific Ocean during a flight from Mexico to Seattle. Everyone aboard the McDonnell Douglas MD-83 was killed, and investigators later determined the cause to be insufficient lubrication of a jackscrew assembly by airline employees during preventive maintenance.

• 1988: A huge section of Aloha Airlines Flight 243’s fuselage blew off in 1988. As a result, the National Transportation Safety Board tightened its maintenance requirements. The 19 year old plane had succumbed to corrosion and widespread fatigue. It may have been prevented if strict inspection and maintenance procedures for high-use aircraft had been in place.

• 1985: Japan Airlines Flight 123 took off without a vertical stabilizer and crashed 32 minutes later.

• Source: Aviation Institute of Maintenance

How the worst maintenance fails could have been prevented

2016-09-27/28 Simplified Technical English as part of an S1000D or ATA iSpec 2200 Implementation 10

Page 11: Simplified Technical English as part of an

This

doc

umen

t and

its

cont

ent i

s th

e pr

oper

ty o

f Ette

plan

. It

shal

l not

be

com

mun

icat

ed to

any

third

par

ty w

ithou

t the

ow

ner’s

writ

ten

cons

ent .

© A

ll rig

hts

rese

rved

.

• Official Specification, ASD-STE100, • Issue 1 release in 1986, currently at Issue 6 (new release every 3 years) • Maintained by STEMG

www.asd-ste100.org

2016-09-27/28 Simplified Technical English as part of an S1000D or ATA iSpec 2200 Implementation 11

Page 12: Simplified Technical English as part of an

This

doc

umen

t and

its

cont

ent i

s th

e pr

oper

ty o

f Ette

plan

. It

shal

l not

be

com

mun

icat

ed to

any

third

par

ty w

ithou

t the

ow

ner’s

writ

ten

cons

ent .

© A

ll rig

hts

rese

rved

.

• STE makes technical English easy to understand – Writing rules Keep it simple, be specific, be consistent – Standardizing terms

• One word = one meaning • Core dictionary (3000)

plus company dictionary

How does it work?

Writing Rules Terminology, Style, Grammar

Approx. 60 rules

ASD-STE100 Dictionary approved words

non-approved words

Company Dictionary Company specific

terminology

2016-09-27/28 Simplified Technical English as part of an S1000D or ATA iSpec 2200 Implementation 12

Page 13: Simplified Technical English as part of an

This

doc

umen

t and

its

cont

ent i

s th

e pr

oper

ty o

f Ette

plan

. It

shal

l not

be

com

mun

icat

ed to

any

third

par

ty w

ithou

t the

ow

ner’s

writ

ten

cons

ent .

© A

ll rig

hts

rese

rved

.

• If installed, remove the guide rails. • Install the component. If installed, remove the guide rails.

• If the guide rails are installed, remove them.

Short is not always good

2016-09-27/28 Simplified Technical English as part of an S1000D or ATA iSpec 2200 Implementation 13

Page 14: Simplified Technical English as part of an

This

doc

umen

t and

its

cont

ent i

s th

e pr

oper

ty o

f Ette

plan

. It

shal

l not

be

com

mun

icat

ed to

any

third

par

ty w

ithou

t the

ow

ner’s

writ

ten

cons

ent .

© A

ll rig

hts

rese

rved

.

A woman hits a man using a hammer.

Make people responsible for their actions

2016-09-27/28 Simplified Technical English as part of an S1000D or ATA iSpec 2200 Implementation 14

Page 15: Simplified Technical English as part of an

This

doc

umen

t and

its

cont

ent i

s th

e pr

oper

ty o

f Ette

plan

. It

shal

l not

be

com

mun

icat

ed to

any

third

par

ty w

ithou

t the

ow

ner’s

writ

ten

cons

ent .

© A

ll rig

hts

rese

rved

.

• Clean the turret dome chassis thermal window securing screw threaded holes and the thermal window 16 securing screws of all previously used sealant using solvent.

• Clean the turret dome chassis thermal window securing screw threaded holes and the thermal window 16 securing screws of all previously used sealant using solvent.

• Clean the 16 screws and the threaded holes of all sealant with solvent.

• From 25 to 13 words (48% reduction).

The bigger the product, the longer the word

2016-09-27/28 Simplified Technical English as part of an S1000D or ATA iSpec 2200 Implementation 15

Page 16: Simplified Technical English as part of an

This

doc

umen

t and

its

cont

ent i

s th

e pr

oper

ty o

f Ette

plan

. It

shal

l not

be

com

mun

icat

ed to

any

third

par

ty w

ithou

t the

ow

ner’s

writ

ten

cons

ent .

© A

ll rig

hts

rese

rved

. • If it doesn’t read correctly, it’s likely not correct STE • Agree on what’s approved and involve stakeholders • Software checks your work but can’t rewrite whole sentences for you,

this is the author’s job

2016-09-27/28 16

Good STE vs. Bad STE

Simplified Technical English as part of an S1000D or ATA iSpec 2200 Implementation

Page 17: Simplified Technical English as part of an

This

doc

umen

t and

its

cont

ent i

s th

e pr

oper

ty o

f Ette

plan

. It

shal

l not

be

com

mun

icat

ed to

any

third

par

ty w

ithou

t the

ow

ner’s

writ

ten

cons

ent .

© A

ll rig

hts

rese

rved

.

1.Train writers on the writing rules – 2 day writing course

2.Standardize terminology – One word = one meaning

3.Quality Control with Software

Steps for Implementation

2016-09-27/28 Simplified Technical English as part of an S1000D or ATA iSpec 2200 Implementation 17

Page 18: Simplified Technical English as part of an

This

doc

umen

t and

its

cont

ent i

s th

e pr

oper

ty o

f Ette

plan

. It

shal

l not

be

com

mun

icat

ed to

any

third

par

ty w

ithou

t the

ow

ner’s

writ

ten

cons

ent .

© A

ll rig

hts

rese

rved

.

• Plugins for: – Microsoft Word – PTC Arbortext – JustSystems XMetaL, XMAX – Adobe FrameMaker, InDesign – Oxygen – Madcap Flare – UltraAuthor

• HyperSTE Desktop (standalone) • CMS integrations, including

ADG R4i, SDL Knowledge Center, PTC Windchill, and others

2016-09-27/28 Simplified Technical English 18

Integrations

Page 19: Simplified Technical English as part of an

This

doc

umen

t and

its

cont

ent i

s th

e pr

oper

ty o

f Ette

plan

. It

shal

l not

be

com

mun

icat

ed to

any

third

par

ty w

ithou

t the

ow

ner’s

writ

ten

cons

ent .

© A

ll rig

hts

rese

rved

.

• Compliance with contract and legal requirements • Unsatisfied end users, e.g. customers and field service engineers • Safety risk, equipment damage / interruption • Legal liabilities • Cost of service business • Preventive maintenance • Bad and costly translations • Endless discussions between SMEs,

Engineers, Authors, Contractors and Suppliers

Issues Addressed

2016-09-27/28 Simplified Technical English as part of an S1000D or ATA iSpec 2200 Implementation 19

Page 20: Simplified Technical English as part of an

This

doc

umen

t and

its

cont

ent i

s th

e pr

oper

ty o

f Ette

plan

. It

shal

l not

be

com

mun

icat

ed to

any

third

par

ty w

ithou

t the

ow

ner’s

writ

ten

cons

ent .

© A

ll rig

hts

rese

rved

.

Compliance with ASD Simplified Technical English (ASD-STE100) Better quality and readability of manuals

For writers: Approximate 81% reduction of grammatical errors and 90% reduction

in Simplified Technical English errors. Approximate 52% reduction in time to find

Simplified Technical English and grammatical errors.

For Quality Assurance: Approximate 48% reduction in time to review

documents for grammatical and Simplified Technical English errors. Approximate 25% increase in grammatical and

Simplified English errors found in documents.

Rolls-Royce Case Study

2016-09-27/28 Simplified Technical English as part of an S1000D or ATA iSpec 2200 Implementation 20

Page 21: Simplified Technical English as part of an

This

doc

umen

t and

its

cont

ent i

s th

e pr

oper

ty o

f Ette

plan

. It

shal

l not

be

com

mun

icat

ed to

any

third

par

ty w

ithou

t the

ow

ner’s

writ

ten

cons

ent .

© A

ll rig

hts

rese

rved

.

Standardized documentation in compliance with ASD-STE100 Improved clarity for maintenance

cards Centralized American Airlines

dictionary Trained authors and engineers

on STE authoring

American Airlines Case Study

2016-09-27/28 Simplified Technical English as part of an S1000D or ATA iSpec 2200 Implementation 21

Page 22: Simplified Technical English as part of an

This

doc

umen

t and

its

cont

ent i

s th

e pr

oper

ty o

f Ette

plan

. It

shal

l not

be

com

mun

icat

ed to

any

third

par

ty w

ithou

t the

ow

ner’s

writ

ten

cons

ent .

© A

ll rig

hts

rese

rved

.

Free Compliance Check Free 112 page booklet

October 16

Free Compliance Check

2016-09-27/28 Simplified Technical English as part of an S1000D or ATA iSpec 2200 Implementation 22

Page 23: Simplified Technical English as part of an

This

doc

umen

t and

its

cont

ent i

s th

e pr

oper

ty o

f Ette

plan

. It

shal

l not

be

com

mun

icat

ed to

any

third

par

ty w

ithou

t the

ow

ner’s

writ

ten

cons

ent .

© A

ll rig

hts

rese

rved

.

STI (SVG / XVL)

OEM

HyperSIS

To Consider

2016-09-27/28 Simplified Technical English as part of an S1000D or ATA iSpec 2200 Implementation 23

Page 24: Simplified Technical English as part of an

This

doc

umen

t and

its

cont

ent i

s th

e pr

oper

ty o

f Ette

plan

. It

shal

l not

be

com

mun

icat

ed to

any

third

par

ty w

ithou

t the

ow

ner’s

writ

ten

cons

ent .

© A

ll rig

hts

rese

rved

.

2016-09-27/28 Simplified Technical English as part of an S1000D or ATA iSpec 2200 Implementation 24

Page 25: Simplified Technical English as part of an

This

doc

umen

t and

its

cont

ent i

s th

e pr

oper

ty o

f Ette

plan

. It

shal

l not

be

com

mun

icat

ed to

any

third

par

ty w

ithou

t the

ow

ner’s

writ

ten

cons

ent .

© A

ll rig

hts

rese

rved

.

Thank you for your attention!

Questions?

North America Contact: [email protected] +1 919 610 2120

etteplan.com | simplifiedenglish.com | technicaldocumentation.services

Europe and Asia Contact: [email protected] +31 6 2705 4431

2016-09-27/28 Simplified Technical English as part of an S1000D or ATA iSpec 2200 Implementation 25