extreme editing

27
© 2013 Leah Guren Editing as an Extreme Sport Leah Guren, Cow TC

Upload: leah-guren

Post on 13-Jan-2015

298 views

Category:

Technology


0 download

DESCRIPTION

 

TRANSCRIPT

Page 1: Extreme editing

© 2013 Leah Guren

Editing as an Extreme Sport

Leah Guren, Cow TC

Page 2: Extreme editing

Let’s get extreme!

Are you ready?

The Three Cs

The Five Faces of Fluff

Page 3: Extreme editing

Are you ready to get extreme?

What’s holding you back?

Holding on to excess content?

Distrusting yourself to slice and dice?

Letting other stakeholders push you around?

???

Set yourself free, baby!

Page 4: Extreme editing

Free your mind with this mantra.

You are under no legal or ethical obligation to document everything.

Page 5: Extreme editing

Learn the three Cs of extreme editing.

Correct

Clear

Curt

Page 6: Extreme editing

Correct

Spelling and grammar

Punctuation • yes: serial (aka Oxford) commas and correct dashes

• no: comma splices and general sloppiness

Data

Up-to-date for product version

Page 7: Extreme editing

Exercise 1: Find the errors.

Changing the Refrigrator Water Filter

1. Remove filter from the box, and removes the coloured

caps on the end of filter.

2. Push the release button that is next too a circular cap

on the grille..

3. Pull the filter out of the grill.

4. Turn the grille cap counter clock wise to remove it from

the old filtre.

5. Place the grille cap on the same place on the new water

filter and turn it clockwize making sure the words on the

filter are facing the right side up and place the new filter

inside the grille.

6. Push it in to the grille until it clucks into place.

Page 8: Extreme editing

Clear

Unambiguous: • not open to interpretation

• “You would be lucky to get Joe to work for you.”

Understandable for reader (correct level): • vocabulary and complexity

• FOG level

Globally understandable • international designations (date, time, etc.)

• no regional idiom or cultural interpretation

Consistent

Layout and design clearly supporting meaning

Page 9: Extreme editing

Exercise 2: Find the ambiguities.

Security Patch 4.167

This software patch for Global Guest Quest should resolve

the reported security problems.

1. Close the application before installing the patch.

2. In services (System configuration in Control Panel),

make sure that Global Quest is activated as single user.

3. Copy all files to the installation directory and run from

there.

4. The next time it is run, choose Reset Data. You can

then use the program without any security risks.

Page 10: Extreme editing

Exercise 3: Find the global confusion.

Thank you for buying this Thermal King product.

We are truly proud of all of our insulated food

containers, but with the Thermal King line, we’ve really

hit it out of the ballpark!

If you have any problems with the product or any

questions, feel free to give us a ring in our customer

service department M-F between 9 am and 5 pm daily.

Specifications

dimensions: 5" base diameter x 9.5" height

weight: 284 grams

volume: 5 pints (2.4 liters)

Page 11: Extreme editing

Curt

Minimalist does not mean rude

Short and to-the-point

No unnecessary words

Stay tuned for the five faces of fluff…

Page 12: Extreme editing

Recognize the five faces of fluff.

incorrect passive voice

pompous writing

waffling

extra words

poorly planned repetition

Page 13: Extreme editing

Avoid passive voice.

Page 14: Extreme editing

Avoid passive voice.

This is not a passive cow; this is a passive-aggressive cow.

Page 15: Extreme editing

Avoid passive voice.

There are only three legitimate cases: • no agent

• emphasizing action

• avoiding blame

Otherwise, rewrite in active voice: • shorter

• easier to understand

• clear responsibility

• easier to translate

Page 16: Extreme editing

Exercise 4: Correct the passive voice.

The vacuum unit should be turned off before changing

any attachments. It is recommended to also unplug the

vacuum unit.

Warning!

The vacuum wide-angle attachment should not be used

when cleaning damp or liquid spills.

Page 17: Extreme editing

Remove the excess formality.

Pompous, formal writing is not “more professional”

Remember, you are answering a question

Use the simplest words

Be straight-forward and honest

“It has come to our attention that this pastoral setting has been rendered incommodious through the dissemination of bovine excrement.”

Page 18: Extreme editing

Be advised that user failure to adhere to

prescribed maintenance procedures increases

the propensity for the system to perform at

substandard levels.

Exercise 5: Take the stick out!

Page 19: Extreme editing

Stop waffling.

Unintentional waffling often means that you don’t really understand

Intentional waffling means that the lawyers got involved!

Say what you mean

Don’t offer multiple ways

Page 20: Extreme editing

Exercise 6: Simplify to a single way.

Select Format Details and complete the fields to

change the format. You can also access the Format

Details dialog box by right-clicking in any Session

active area, or by using <Ctrl+F>, or by accessing the

Session properties (Active Session

Properties Modify).

Page 21: Extreme editing

Consider the cost of every word.

Every word is a potential barrier

Hidden strong verbs: • The meeting came to an end at 14:30. (ended)

• Richard reached a decision about dessert. (decided)

Bloated phrases and meaningless filler: • at this point in time (now)

• in spite of the fact that (although)

• located on (on)

Page 22: Extreme editing

Exercise 7: Use the strong verb.

The test cycle completion occurs when all

reviewers come to an agreement over the

inclusion of elements in the final release.

Page 23: Extreme editing

Don’t repeat unless in a critical path.

Info is modular

No one reads documentation, but uses it in a non-linear manner

Only repeat mission-critical info in the middle of a work flow

Use xrefs correctly but sparingly

Page 24: Extreme editing

All of the special keys are described here along with

their functions and uses.

Shortcut

F3

F4

F5

F7

F9

Function

Use this key to access system help.

Use this key to launch the SQL Wizard.

Use this key to open the Designer.

Use this key to send a user request.

Use this key to search messages.

Exercise 8: Strip out duplication.

Page 25: Extreme editing

How do you meet your goals?

Know your stuff: • basics (grammar, punctuation, syntax, usage)

• language

• writing style for TC

Don’t neglect subject matter

Think first, edit after!

Page 26: Extreme editing

It may surprise you to realize that your user

identification is not character-restricted or

limited to a short length. In fact, any

alphanumeric string, up to 100 characters,

can be recognized by the system as long

as it doesn’t include spaces.

Exercise 9: Try the bonus round!

Page 27: Extreme editing

Thank you!

Leah Guren technical communication training & consulting

tel: (+972) 54-485-3473

email: [email protected]

Skype: leah.guren

website: www.cowtc.com

A butter

approach to

TC…