22am01A SE TutorialWeb

8/13/2019 22am01A SE TutorialWeb

1/70

10/11/2004

ASD (AECMA) SIMPLIFIED ENGLISHExtracts from the Airbus France Training Course for AuthorsKathy Barthe, Airbus

ASD SEMG Chairperson


2/70

10/11/2004 Page 2AIRBUSS.A.S.

Allrightsreserved.

Confidentialandproprietary

document.

AECMA(now ASD)

Simplified English


3/70


Allrightsreserved.


document.

Background

1979: Request from the AEA (Association of European Airlines)

to

AECMA (Association of European Aerospace Industries )

For manuals

More easily understandable

With a more consistent style

in particular for

Non-native speakers of EnglishEasier translation (or better, no translation)


4/70


Allrightsreserved.


document.

And after that?

1979-82: Investigation by AECMA,Initial work by Fokker,Contacts with AIA (Aerospace Industries

Association of America)

1983: AECMA Simplified English Project Group- Representatives of 5 AECMA member countries

+ US

- Civil aeronautics, but also military

1986: 1st release of the SE GuideFirst users

Becomes an ATA 100 requirement for civil aircraftdocumentation.

2004: Current release (Issue 2)


5/70


Allrightsreserved.


document.

ATA Spec i2200

Text and Material - Style

1.1. Text ContentText shall be brief and concise. The sentence structure shall be

simple and direct, avoiding the obvious and the elementary, andomitting discussions of theory except where essential for practicalunderstanding and application. All related data shall be groupedin a logical manner.

Writing rules and vocabulary shall be inaccordance with AECMA SimplifiedEnglish [AECMA No. PSC-85-16598].

Instructions shall be covered adequately by text or tabular dataand presented so that conversion to equivalent equipment may bedetermined.


6/70


Allrightsreserved.

Confidentialandproprietarydocument.

So what is Simplified English

Rules

related to style features

for:

Maximum READABILITY

ofAIRCRAFT Documentation


7/70

10/11/2004 Page 7AIRBUSS.A.S

.Allrightsreserved.


SE Designed for

Aircraft Maintenance Manuals (AMM)

Trouble Shooting Manuals (TSM)

Component Maintenance Manuals (CMM)(Vendors)

But can be (and is) adapted to other manuals

and other industries


8/70


.Allrightsreserved.


SE consists of

62 rules

Words

Noun phrases

VerbsSentences

Procedures

Descriptive text

Warnings, Cautions and Notes

Punctuation and word counts

Writing Practices

A Dictionary of approved general words

All contained in a Guide


9/70


.Allrightsreserved.


Some Examples

Non-SEIt is equally important thatthere shouldbe no seasonal

changes in the procedures, as,although aircraft fuel systemicingdue towatercontamination is more often

met within winter, it can beequally dangerous during thesummer months.

Sentence of 40 words

Complex sentence structure Noun cluster Ambiguous words


10/70


.Allrightsreserved.

Confidentialandproprietar

ydocument.

Some Examples

Non-SEIt is equally important that thereshouldbe no seasonal changes inthe procedures, as, although aircraftfuel system icing due towatercontamination is more often met within winter, it can be equallydangerous during the summermonths.

Sentence of 40 words Complex sentence structure Noun cluster Ambiguous words

SE Use the same procedures

all the time, becausewater in the fuel systemcan freeze duringsummer or winter.

Sentence of 19 words

Simple sentence structure Simple words No long noun clusters


11/70


.Allrightsreserved.


ydocument.

Some Examples

Non-SE This topic is for inspection of

the outer wing bottom skinlower surface spanwise skinjoints at stringer 13 andstringer 20 between Rib 12and Rib 27 excluding areascovered by flap track fairings

3, 4 and 5.

One sentence of 39 words

A noun cluster of 9 words No punctuation Ambiguous -ing form


12/70


.Allrightsreserved.


ydocument.

Some Examples

Non-SE This topic is for inspection of the

outer wing bottom skin lower surface

spanwise skin joints at stringer 13

and stringer 20 between Rib 12 andRib 27 excluding areas covered byflap track fairings 3, 4 and 5.

One sentence of 39 words A noun cluster of 9 words

No punctuation

Ambiguous -ing form

SE This topic gives the inspectionprocedure for the longitudinal

skin joints on the lower surface of

the outer wing.The skin joints are on the externalsurface of the skin, at stringers 13and 20, between ribs 12 and 27.This procedure does not include

inspection of the area above flaptrack fairings 3, 4 and 5.

Three sentences of 19, 21 and 17words

No noun cluster of more than threeelements


13/70


.Allrightsreserved.


SE only for civil aircraft?

No.

Original request from airlines, but SE is also formilitary aircraft

Is already used in various military programs.

Has always been a requirement of S1000D.


14/70


.Allrightsreserved.


S1000D Issue 2


15/70


.Allrightsreserved.


Who uses SE?

Civil aircraft

Airbus: Maintenance documentation forA320, A340 and now A38O families

Boeing/Douglas: Maintenance documentation forB737 aircraft and subsequent, andfor MD11 + B717 (ex-MD95)

Bombardier: Global Express, ...

Westland/Agusta: Helicopters

Engine mfrs: Maintenance documentation forengines

Vendors: Component Maintenance Manuals


16/70

10/11/2004 Page 16AIRBUSS.A.

S.

Allrightsreserved.


Who uses SE?

Military aircraft

Eurofighter

Gripen (SAAB)

Helicopters

And soon Airbus A400M


17/70


S.

Allrightsreserved.

Confidentialandproprieta

rydocument.

Is the Guide set in stone?

No. Is updated regularly. Possible to proposemodifications.


18/70


S.

Allrightsreserved.


rydocument.

By whom?The AECMA Simplified English Maintenance Group

(SEMG)

Representatives from :FRANCE (Airbus France, for the

GIFAS) - Chair

GERMANY (Airbus Germany, for

the BDLI)

ITALY (Secondo Mona for the

AIAD) Vice ChairSPAIN (EADS CASA Seville for

ATECMA)

SWEDEN (SAAB-Gripen for the

SAI)UK (Westland Helicopters, for

the SBAC)

UNITED STATES (Boeing, forAIA)

CANADA (Bombardier, forAIA-C)

+Observers from

SCANDINAVIAN AIRLINESYSTEM (SAS),and

TURKISH AIRLINES


19/70


S.

Allrightsreserved.


rydocument.

Is SE used outside the aerospace industry?

Interest by firms such as:

Shell

Software manufacturers

S.W.I.F.T (clearing bank in Belgium)

Locomotive manufacturers

Medical equipment companies


20/70


S.

Allrightsreserved.


rydocument.

Are there other forms of Controlled English?

Before SE

Basic English (1930s)

Caterpillar Fundamental English

International Language of Service and Maintenance(ILSAM)

Bull Global English

Xerox Multilingual Customized English


21/70


Allrightsreserved.


rydocument.

Since SE

Caterpillar Technical English

General Motors Controlled Automotive ServiceLanguage (CASL)

Diebold Controlled English

Easy English (IBM), ...


22/70


Allrightsreserved.


rydocument.

Does SE work?

ComprehensionHuman Factors study by the FAA showed:

Yes, in all cases for non-native speakers of English

Yes, for complex procedures for native speakers ofEnglish

Translatability

Study by the University of Washington with Boeingshowed:

Significant decrease in the time needed.


23/70


Allrightsreserved.


Supporting tools?

Electronic version of the Guide

Checkers: syntax checkers


24/70


Allrightsreserved.


Checkers?

The ASD SE group does not endorse any softwareproducts.

But most of us do have some experience withcheckers.

Tips available on the SEMG Web site.


25/70

10/11/2004 Page 25AIRBUSS.A

.S.

Allrightsreserved.


Checkers

In general:Checkers are aids, but will not think in your place.

They will tell you if a word or construction is not

approved, but will not tell you how to rewrite thesentence.

Test software before you buy it (ask for a test licence

for at least two months).Make sure that it checks the real thing (ASD SE), and

not some other form of controlled English.

Test it for compliance with your computer platform, ofcourse (does it run OK, are there bugs, response time,are there particular features of your system that itcannot deal with)


26/70


.S.

Allrightsreserved.


Checkers

But above all, test it for accuracy of parsing:Are the error messages it sends correct?

What is the percentage of expected error messages not

sent?

What can it not deal with (such as carriage returns atthe end of lines)?

Can the user update the dictionaries himself or does ithave to be done by the software provider?

What sort of words can the user put in the dictionaries? Does the provider provide updates when there are new

issues of the SE Guide?


27/70


.S.

Allrightsreserved.

Confidentialandpropriet

arydocument.

And training?

Training is available from some members of the SE group,in Europe and in North America.

The SE group does not endorse any trainers.

Tips on the SE Web site. In general:Make sure the trainer has been trained himself by an SE

group member.

Make sure he uses the latest issue of the Guide.

Ask which rules he covers.


28/70


.S.

Allrightsreserved.


Tips

AECMA SE Maintenance Group Web site:

http://www.simplifiedenglish-aecma.org

Two documents:

LOOKING FOR SE TRAINING?

Some tips

LOOKING FOR AUTHORING AIDS FOR SE?

Some tips


29/70


.S.

Allrightsreserved.


SIMPLIFIED ENGLISH

the nuts and bolts


30/70


.S.

Allrightsreserved.


The rules

Words

Noun Phrases

Verbs

Sentences

Procedures

Descriptive Text


Punctuation and Word Counts

Writing Practices


31/70


.S.

Allrightsreserved.


Words

2 major types of word

1 - CONTROLLED ( = restricted use)

General words approx. 860 approved words

2 - NOT CONTROLLED

Technical Names - 20 categories

Technical Verbs - 3 categories


32/70


.S.

Allrightsreserved.

Confidentialandproprie

tarydocument.

Technical Names

RULE: 1.1 Choose the words from:- - Words that qualify as

Technical Names (TN)-

20 categories

One-word TNs: platform

Multi-word TNs: accessplatformacceptancecheck

mainhydraulicpower


33/70


.S.

Allrightsreserved.


tarydocument.

Technical Names Parts of Speech

RULE: 1.6 Use a Technical Name only as a

noun or an adjective, not as a verb

BOLT:

Attach the plate with a bolt. ? Bolt the two plates together. ?

OIL

Fill the Integrated Drive Generator (IDG) with oil.?

Oil the IDG. ?

T h i l V b


34/70


Allrightsreserved.


tarydocument.

Technical Verbs

RULE: 1.1 Choose the words from:

- - - Words that qualify as

Technical Verbs3 categories

RULE: 1.11 Use Technical Verbs only as verbs,not as nouns.

W d i th Di ti


35/70


Allrightsreserved.


tarydocument.

Words in the Dictionary

RULE: 1.1 Choose the words from:

-Approved words in the

-Dictionary (Part 2)

- -

Selected on the basis of:Analysis of the words used in maintenance procedures

Selection criteria:. One word for one meaning

. One meaning for one word

. One part of speech for one word

. The shortest and most everyday words

. American words and spelling



36/70


Allrightsreserved.


tarydocument.

Words in the DictionaryParts of Speech

RULE: 1.2 Use approved words from theDictionary only as the part ofspeech given

TEST

Test the system for leaks. ?

Do a test for leaks in the system. ?



37/70


Allrightsreserved.


tarydocument.

Words in the DictionaryParts of Speech

RULE: 1.2 Use approved words from theDictionary only as the part ofspeech given

TEST

Test the system for leaks.

Do a test for leaks in the system.



38/70

10/11/2004 Page 38AIRBUSS.

A.S.

Allrightsreserved.


tarydocument.

Words in the DictionaryMeanings

RULE: 1.3 Keep to the approved meaning of aword in the Dictionary. Do not usethe word with any other meaning.

FEEL (v)

Feel the part to find if it is smooth?

If you feel that the test is not satisfactory, ?



39/70


Allrightsreserved.


s a yMeanings

RULE: 1.3 Keep to the approved meaning of aword in the Dictionary. Do not usethe word with any other meaning.

FEEL (v)

Feel the part to find if it is smooth

If you feel that the test is not satisfactory,



40/70


Allrightsreserved.


yForms

RULE: 1.4 Only use those forms of verbs andadjectives shown in the Dictionary

DRINK (v)

DRINKS, DRANK, DRUNK drinking?

MUST (v)

NOTE: No other forms of this verb

BURN (v) burnt?

DIM (adj)

DIM (DIMMER, DIMMEST)

TACKY (adj)

NOTE: No other form of this adjective

Words


41/70


Allrightsreserved.


Specific writing (not abstract)

RULE: 1.13 Make your instructions as specificas possible

Different temperatures will change the cure time?

Increase the temperature to decrease the cure time.

Several levels of system and component failure aredefined for which the cabin data system gives warning

to the appropriate crew members.How many levels? What systems? Whichcomponents? Which crew members? What kind ofwarning?


42/70


Allrightsreserved.


Words

Noun Phrases

Verbs

Sentences

Procedures

Descriptive text



Writing practices

Noun clusters


43/70

10/11/2004 Page 43AIRBUSS

.A.S.

Allrightsreserved.


Noun clusters

RULE: 2.1 Do not make noun clusters of morethan three nouns

icing

system icing

fuel system icingaircraft fuel system icing

icing of the aircraft fuel system

runway light connection resistance calibration

calibration of the resistance of the runway lightconnection

Noun clusters


44/70


.A.S.

Allrightsreserved.


Noun clusters

RULE: 2.2 Clarify noun clusters that areTechnical Names with one of these twomethods:

Use hyphens to show the relationship between the most closelyrelated words

ramp service-door safety connector-pin

Explain the noun cluster. Then, if possible, use a shorter name afterthe initial explanation.

Engage the ramp service door safety connector pin (the pin that holds

the ramp service door, referred to in this procedure as the safetyconnector pin).

BUT: do not use hyphens if you can obey Rule 2.1

Articles


45/70


.A.S.

Allrightsreserved.


Articles

RULE: 2.3 When appropriate, use an article(the, a, an) or a demonstrative

adjective (this, these) before anoun.

Stop start procedure?Remove bolt and stop?

Or

Stop the start procedure.

Remove the bolt and the stop.


46/70


.A.S.

Allrightsreserved.


Words

Noun phrases

VerbsSentences

Procedures

Descriptive textWarnings, Cautions and Notes


Writing Practices

Verbs


47/70


.A.S.

Allrightsreserved.

Confidentialandpropr

ietarydocument.

Verbs

Action verbs express:An action: (to) sing, (to) read, (to) pressurize

I sing, you read, we pressurize

A mode of being: (to) have, (to) be

I have a cold, I am cold

Helping verbs:(

to) have, (to) be, can, will, must, doCan you sing? You must close the doorDid the light come on?

Verbs


48/70


.A.S.

Allrightsreserved.

Confidentialandpropr

ietarydocument.

Verbs

Different forms, to express:

Person (I sing, he sings)

Time (present, past, future)

I sing/I am singing

I sang/I was singing

I have sung (this song before)

I will sing/I am going to sing (this song tomorrow)

What can you do with these forms?


49/70


.A.S.

Allrightsreserved.


y

RULE: 3.2 Use the approved forms of the verbto make only:

- The infinitive (to) pressurize

- The imperative Pressurize! Do notpressurize

- The simple present tense If you pressurize- The simple past tense If you pressurized- The future tense. You will pressurize

Tense: a form of the verb that expresses TIME:

present, past, future

VerbsThe past participle


50/70


.A.S.

Allrightsreserved.


The past participle

RULE: 3.3 Use the past participle only as anadjective, either with a noun or after

the verbs TO BE, TO BECOMEThe hydraulic reservoir is a pressurized vessel.

At the end of the test, make sure that the reservoir is(still) pressurized.

RULE: 3.4 Do not use the past participle with a

form of the verb TO HAVE to makean unapproved tense.

When the pump has pressurized the system,

VerbsThe present participle


51/70


.A.S.

Allrightsreserved.


The present participle

Pressurizing

Make sure that the pump is pressurizingthe system.

IMPLICITLY NOT PERMITTED IN SE.

IS NOT A VERB FORM LISTED IN THE DICTIONARY.

Only these ing words permitted:

REMAINING (adj), MISSING (adj) and DURING (pre)And

Some Technical Names (housing, bearing, )

Active and Passive


52/70


Allrightsreserved.


RULE: 3.6 Use the active voice. Use only the

active voice in procedural writing,and as much as possible in descriptive

writing.

Active and Passive


53/70


Allrightsreserved.

Confidentialandprop

rietarydocument.

ACTIVE VOICE: the subject of the sentence does theaction (is active).

The pump pressurizes the hydraulic system to 3000psi.

(The pump does the action of pressurizing)

PASSIVE VOICE: the subject of the sentence receives theaction (is passive)The hydraulic system is pressurized to 3000 psi by the

pump.

(The hydraulic system receives the action of being pressurized)

TO BE + PAST PARTICIPLE

Agent: whoever or whatever does the action - the pump

Why does SE call for the active voice?


54/70


Allrightsreserved.

Confidentialandprop

rietarydocument.

Because:

The passive is a compound verb form. SE encourages simple forms.

Risk of confusion with the past participle used as an adjective.

Passives encourage the use of support (prop) verbs with actionnouns.

The measurement can be made using tool PN XXX

In procedures, passives often used instead of imperatives.

The test shall be done using XXXX.

Passives are often not necessary.

Passive or adjective?


55/70


Allrightsreserved.

Confidentialandprop

rietarydocument.

Passive: verb form, therefore = action

Be careful when you move the XXXX. It can bedamaged during extension of the landing gear.

Adjective: describes a state, not an action

If the XXXX is damaged, you must repair it.

Passive or adjective?A good test


56/70

10/11/2004 Page 56AIRBUS

S.A.S.

Allrightsreserved.

Confidentialandprop

rietarydocument.

A good test

AskBY WHOM? BY WHAT?

= Is there an agent?

If yes, is a passive.

The agent can be specified:The reservoir is pressurized by air from the engines

Or it can be implicit: The relay is then de-energized and the light comes on.

VerbsExpressing action


57/70


S.A.S.

Allrightsreserved.

Confidentialandprop

rietarydocument.

Expressing action

RULE: 3.7 If there is an approved verb todescribe an action, use the verb, not

a noun or other part of speech.

NOT: The ohmmeter gives an indication of 450 22ohms.

BUT: The ohmmeter shows 450 22 ohms.

NOT: The guidance of the rod is made by two bearings.

BUT: The rod is guided by two bearings.Or

Two bearings guide the rod.


58/70


S.A.S.

Allrightsreserved.

Confidentialandprop

rietarydocument.

Words

Noun phrases

Verbs

Sentences

Procedures

Descriptive text


Punctuation and word countsWriting practices

Sentences


59/70


S.A.S.

Allrightsreserved.

Confidentialandprop

rietarydocument.

RULE: 4.3 Use a tabular layout (vertical layout)for complex texts.

During the final movement of the landing gear retraction, thedoor operating bar located on the leg contacts and turns thelatch, withdrawing the roller from the slot, and the second

roller entraps the door operating bar.

When the landing gear retracts:- The door operating bar on the leg touches and turns

the latch.- This causes the roller to move out of the slot.- The second roller holds the door operating bar.


60/70


S.A.S.

Allrightsreserved.


Words

Noun Phrases

Verbs

Sentences

Procedures

Descriptive text



Writing practices

Procedures


61/70


S.A.S.

Allrightsreserved.


RULE: 5.1 Keep procedural sentences as shortas possible (20 words maximum)

(Word counts - Section 8 of the Guide)

RULE: 5.2 Write only one instruction per

sentence

Procedures


62/70


S.A.S.

Allrightsreserved.


RULE: 5.4 In an instruction, write the verb inthe imperative (commanding)form.

Oil and grease are to be removed with a degreasing agent.

Remove oil and grease with a degreasing agent.

If the cleaned parts are not examined immediately, protectionshall be applied to prevent damage and corrosion.

If you do not examine the cleaned parts immediately,apply protection on the parts to prevent damage andcorrosion.


63/70


S.A.S.

Allrightsreserved.


WordsNoun phrases

Verbs

Sentences

ProceduresDescriptive text


Punctuation and Word counts

Writing practices

Warnings and Cautions


64/70


S.A.S.

Allrightsreserved.

Confidentialandpro

prietarydocument.

RULE: 7.4 Identify your command correctly as awarning or a caution.

RULE: 7.1 Start a warning or a caution with a simple orclear command.

RULE: 7.3 If necessary, add a brief explanation togive a clear idea of the possible risk.

RULE: 7.5 If a condition is necessary before thetechnician continues, put the conditionfirst.

Notes


65/70


S.A.S.

Allrightsreserved.

Confidentialandpro

prietarydocument.

Extract from ATA i2200:

G. Warnings, Cautions, and Notes

... Notes call attention to methods whichmake the job easier. ...

Notes shall follow the text to which they relate and belocated directly under and vertically in line with the text towhich they apply.

Warnings, cautions and notes shall always be on the

same page as the text to which they apply

Notes - S1000D definition


66/70


S.A.S.

Allrightsreserved.

Confidentialandpro

prietarydocument.

Chapter 2.7Warnings, cautions and notes

1 Definitions

...

1.3 Notes

Notes used in Data Modules/TechnicalPublications give the user additional

information which is helpful but does notbelong to the immediate subject. Maintenancetasks can be made easier by the use of Notes,

but when used, they do not take the place ofprocedural information.


67/70

Punctuation


68/70


S.A.S.

Allrightsreserved.

Confidentialandpro

prietarydocument.

See the SE Guide

Writing Practices


69/70


S.A.S.

Allrightsreserved.

Confidentialandpro

prietarydocument.

RULE: 9.1 Use a different construction to rewritesentences in Simplified English when aword-for-word replacement is notsufficient.

Sight gage oil level must be visible at all times during the test.

Make sure that you can see the oil level on the sight gage

during the test.

If the air intake flap is failed, deactivate air inlet valve before next flight.

If the air , disconnect (stop, isolate) the air inlet valve?If the air , lock the air inlet valve in the fully open position

If the air , do the deactivation procedure for the air

Writing Practices


70/70


Allrightsreserved.


RULE: 9.2 When you combine words to make aphrase, make sure that the words

continue to obey the meanings givento them in the Dictionary.

When the fire is put out, close the valve?

When the fire is extinguished, close the valve.

22am01A SE TutorialWeb

Documents

Transcript of 22am01A SE TutorialWeb