Editing—the Object-Oriented Way

 

One advantage of taking an object-oriented approach to content is that you can be more efficient—some might say merciless—as an editor.

 

When you have a clear idea of the standard structure an object should follow, and the purpose of each component, you can discard junk text, rearrange loose ends, and prune the prose to make it serve the user’s goals. 

 

When well designed, the pattern reflects the needs and thinking of the user. So reshaping the prose to match the pattern will help people find what they want, use the prose without a lot of thinking, and get out fast.

 

Here’s an example of object-oriented editing, showing the text before, the editor’s analysis, and the edited text, afterward.

 

Before

 

We pay return shipping. Why?  Because we want you to be satisfied, and if you’re not, we do everything we can to make it up to you. Free shipping both ways is our way of apologizing for any disappointment you may have experienced. Use this RL to make sure that your product goes back to our warehouse, and that you get credit for the return. Call the 800 number for FedEx, and ask them to pick up the package. FedEx brings the package back to us in 3 to 5 days. At that point, we check it in, and issue your credit. In a few weeks, the credit shows up on your credit card statement. So take the Return Label (included with your order information in the box) and paste that on the outside of the box, on top of the original shipping label. Use the Return Label to make sure that the product goes back to our warehouse, and that you get credit for it.

 

 

What’s Wrong

The procedure is a single paragraph.  Problems, according to users:

 

The Editor Goes to Work

 

The editor looks up the model for a procedure.

 

 

 

The model shows what objects may go into a Procedure, in what order.  It shows, for instance, that there must be a Name, an Introduction, and at least one Instruction, in that order.  Within each Instruction, there is a Step, with a related Explanation and Result.

 

The editor reads about the model. A table answers the editor’s questions about each object.  For instance, the tables reveal that although each Instruction must have a Step, the Explanation and Result are optional.

 

 

Object: Procedure

 

 

What is the object’s class?

Procedure

 

What is its function?

To answer the question: How do I do this task?

 

What is it a component of?

A group of related procedures.

 

What are its components?

Name (1), Introduction (1), Instruction (1 or more)

 

Which of its components are required?

You must have at least one Instruction.

 

What other objects link to this one?

Menu items, See Also items link to this object.

 

 

 

 

Object: Name

 

 

What is the object’s class?

Name

 

What is its function?

To answer the question: What kind of task can I do with this procedure?

 

What is it a component of?

The Procedure.

 

What are its components?

None.  It is made up of text, but it contains no other objects as components.

 

What other objects link to this one?

None.  All links come to the Procedure, as a whole.

 

 

Object: Introduction

 

What is the object’s class?

Introduction

 

What is its function?

To answer the question: What do I need to know before I do this?

 

What is it a component of?

The Procedure.

 

What are its components?

None.

 

What other objects link to this one?

None.

 

 

Object: Instruction

 

 

What is the object’s class?

Instruction

 

What is its function?

To answer the question: What do I do next?

 

What is it a component of?

The Procedure.

 

What are its components?

Step (1) and Explanation (0 or more), and Result (1 or more). So an Instruction must have one Step.  Explanations and Results are optional.

 

Which of its components are required?

The Step.

 

What other objects link to this one?

None.

 

 

 

Object: Step

 

 

What is the object’s class?

Step

 

What is its function?

To answer the question: What action do I take?

 

What is it a component of?

An Instruction.

 

What are its components?

None. This is just text.

 

What other objects link to this one?

None.

 

 

 

Object: Explanation

 

 

What is the object’s class?

Explanation.

 

What is its function?

To answer the question: What do I need to know to carry out the action?

 

What is it a component of?

An Instruction.

 

What are its components?

None.

 

What other objects link to this one?

None.

 

 

 

Object: Result

 

 

What is the object’s class?

Result.

 

What is its function?

To answer the question: What result should I expect after I take the action indicated in the Step?

 

What is it a component of?

An Instruction.

 

What other objects link to this one?

None.

 

 

Now, following the model, the editor rearranges the material, labeling each element.  Then, trimming and modifying text, the editor reissues the procedure, as a series of objects.

 

Analysis

The editor sorts the raw material out into objects, thinking about the function of each element.

 

Object

Text

 

Name

To Return a Product

 

Introduction

If you don’t like one of our products, for whatever reason, you can return it for a full refund, as long as you have not damaged it.

 

Instruction: Step

Take the Return Label (included with your order information in the box) and paste that on the outside of the box, on top of the original shipping label.

 

Instruction: Explanation

This Return Label makes sure that your product goes back to our warehouse, and that you get credit for the return.

 

Instruction: Step

Call the 800 number for FedEx, and ask them to pick up the package.

 

Instruction: Explanation

We pay return shipping. Why?  Because we want you to be satisfied, and if you’re not, we do everything we can to make it up to you. Free shipping both ways is our way of apologizing for any disappointment you may have experienced.

 

Instruction: Result

What happens next? FedEx brings the package back to us in 3 to 5 days. At that point, we check it in, and issue your credit. In a few weeks, the credit shows up on your credit card statement.

 

 

The editor isolates each type of object, putting each object in its own paragraph, so users can distinguish them.  Then the editor uses a stylesheet to apply a distinct format to each one, so users can spot the difference right away.

After

 

Here is the result of the object-oriented edits, with the styles applied.

To Return a Product

If you don’t like one of our products, for whatever reason, you can return it for a full refund, as long as you have not damaged it.

 

1. Take the Return Label (included with your order information in the box) and paste that on the outside of the box, on top of the original shipping label.

This Return Label makes sure that your product goes back to our warehouse, and that you get credit for the return.

2. Call the 800 number for FedEx, and ask them to pick up the package.

We pay return shipping. Why?  Because we want you to be satisfied, and if you’re not, we do everything we can to make it up to you. Free shipping both ways is our way of apologizing for any disappointment you may have experienced.

What happens next? FedEx brings the package back to us in 3 to 5 days. At that point, we check it in, and issue your credit. In a few weeks, the credit shows up on your credit card statement.

 

 

 


Challenge

Using this model of a procedure, reorganize the following procedure.

 

DRIP by Drip

 

The gradual approach is safest.  Choose Shareholder in the menu on the left.  You can build your holdings of shares in our stock one dividend at a time, drop by drop. On the Shareholder page, choose the Dividend Reinvestment Plan, or DRIP. Placing your stock in a DRIP lets you increase your holding without having to mail off a check, or pay broker’s fees. Fill out the form, and submit. In a moment you see a confirmation.  Print the confirmation, and keep that for your records. Within a few minutes, you also receive an email confirming that your shares are now held in a DRIP account for you, and that future dividends will be automatically reinvested in the company stock.  Print and save the email, as well. Congratulations. From now on, every dividend will be reinvested, expanding your holdings. You are using regular dividends to acquire more stock, without having to send in a check, or pay a broker’s fee.  Note: Before filling out the form, you will need to have a check from your regular bank account available, to provide the bank transfer number.

 

Use a table like this for your analysis. (You may need to add or subtract rows).

 

Object

Text

 

Name

 

 

Introduction

 

 

Instruction: Step

 

 

Instruction: Explanation

 

 

Instruction: Result