18
ACCURACY Accuracy in technical writing required that the writer proof reads the text. To ensure accurate writing, use the following tips: 1. Let someone else read it. 2. Use the gestation approach. 3. Read Backwards 4. Read one line at a time 5. Read along words (Syllable by syllable) 6. Use Technology

The Technical Writing Process

Embed Size (px)

Citation preview

Page 1: The Technical Writing Process

ACCURACY

Accuracy in technical writing required that the writer proof reads the text. To ensure accurate writing, use the following tips:

1. Let someone else read it.2. Use the gestation approach.3. Read Backwards4. Read one line at a time5. Read along words (Syllable by syllable)6. Use Technology

Page 2: The Technical Writing Process

ACCURACY

Accuracy in technical writing required that the writer proof reads the text. To ensure accurate writing, use the following tips:

7. Check figures, scientific and technical equations and abbreviations.

8. Read it a loud.9. Try Scattershot proofing.10. Use a dictionary.

Page 3: The Technical Writing Process

ORGANIZATION

It allows the readers to follow the train of thought of the writer.

Organizational Patterns:

1. Spatial2. Chronological3. Importance4. Comparison / Contrast5. Problem / Solution

Page 4: The Technical Writing Process

THE TECHNICAL WRITING PROCESSEffective Strategies in Technical Writing

By Alex V. Abelos et. al.

Page 5: The Technical Writing Process

THE TECHNICAL WRITING PROCESS

Prewrite

Allows a writer to spend quality time, prior to writing the correspondence, generating information.

a. Determine the Objectivesb. Gather Datac. Consider Audience

Page 6: The Technical Writing Process

THE TECHNICAL WRITING PROCESS

Write

Drafting of the technical document.

a. Organizing the draft in logical sequence.

b. Formatting of the Content

Page 7: The Technical Writing Process

THE TECHNICAL WRITING PROCESS

Rewrite

Revision of the rough draft. It allows you to perfect your technical document.

Page 8: The Technical Writing Process

PREWRITING STAGE

1. Plan your technical writing.

Before the writer write the document, he/she needs to know why he/she is writing and what he/she hope to achieve.

Recognizing the purpose of the correspondence makes a difference. This allows the writer to provide the appropriate tone and scope detail in his/her writing.

Page 9: The Technical Writing Process

PREWRITING STAGE

2. Gather Data.

A writer cannot communicate the content until the he/she have gathered the data.

3. Consider the Audience.

Before a writer can determine what to say and how much detail is necessary, he/she should determine his/her target audience.

Page 10: The Technical Writing Process

WRITING STAGE

1. Package the Data.

A writer cannot communicate the content until the writer have gathered the data.

2. Organize your thoughts in logical and easy to follow sequence

3. Format your text to allow ease of access

Page 11: The Technical Writing Process

REWRITING STAGE

Revision requires the writer to look over the draft and do the following:

1. Add any missing detail for clarity.2. Delete dead words for conciseness.3. Simplify complex words and phrases.4. Move information around to ensure that your most

important ideas are emphasized.5. Reformat to ensure ease of access.6. Enhance the tone and style of the text.7. Correct any errors to ensure accurate grammar

content.

Page 12: The Technical Writing Process

WRITING MEMOSEffective Strategies in Technical Writing

By Alex V. Abelos et. al.

Page 13: The Technical Writing Process

MEMOS HAVE A TWOFOLD PURPOSE:

It brings attention to problems and it solve problems.

It updates the reader about new information like policy changes, price increases, or by persuading the reader to take an action, such as to attend a meeting, or change a current production procedure.

(Memos are most effective when they connect the purpose of the writer with the interests and needs of the reader.)

Page 14: The Technical Writing Process

CRITERIA FOR WRITING SUCCESSFUL MEMOS

Content

The memo includes To, From, Date, and Subject lines.

The subject line clearly forecasts the memo's content.

The memo is short and includes readable blocks of information.

Page 15: The Technical Writing Process

CRITERIA FOR WRITING SUCCESSFUL MEMOS

Arrangement

The memo follows a top-down approach, with the most important information emphasized at the beginning of the message.

Transitions between memo parts are clear and logical.

Page 16: The Technical Writing Process

CRITERIA FOR WRITING SUCCESSFUL MEMOS

Style

The tone is appropriate for the intended readers.

All words are spelled correctly.

The style is clear, concise, fluent, and devoid of grammatical errors.

The memo's appearance and font are suitable for a business setting.

Page 17: The Technical Writing Process

Heading SegmentThe heading segment follows this general format:

TO: (readers' names and job titles)

FROM: (your name and job title)

DATE: (complete and current date)

SUBJECT: (what the memo is about, highlighted in some way)

Page 18: The Technical Writing Process

SAMPLE MEMORANDUM