Prof. Wozencraft ENG227

1. The writing process consists of five steps:
• planning
• drafting
• revising
• editing
• proofreading
Chapter 3. Writing Technical Documents © 2012 by Bedford/St. Martin's 1

2. Planning involves seven steps:
• analyzing your audience
• analyzing your purpose
• generating ideas about your subject
• researching additional information
• organizing and outlining your document
• selecting an application, a design, and a delivery
method
• devising a schedule and a budget
Chapter 3. Writing Technical Documents © 2012 by Bedford/St. Martin's 2

3. When you draft,
follow these six suggestions:
• Get comfortable.
• Start with the easiest topics.
• Draft quickly.
• Don’t stop to get more information or to revise.
• Try invisible writing.
• Stop in the middle of a section.
Chapter 3. Writing Technical Documents © 2012 by Bedford/St. Martin's 3

4. Commercial templates
can lead to three problems:
• They do not always reflect the best design
principles.
• They bore readers.
• They cannot help you answer the important
questions about your document.
Chapter 3. Writing Technical Documents © 2012 by Bedford/St. Martin's 4

5. Identify the strengths and weaknesses
of a commercial template.
Chapter 3. Writing Technical Documents © 2012 by Bedford/St. Martin's 5

6. Revising entails reconsidering three items:
• your audience
• your purpose
• your subject
Chapter 3. Writing Technical Documents © 2012 by Bedford/St. Martin's 6

7. There are two ways to study your draft:
• studying the draft by yourself
• seeking help from others
Chapter 3. Writing Technical Documents © 2012 by Bedford/St. Martin's 7

8. When revising documents,
ask for help from two kinds of people:
• subject-matter experts
• current and prospective users of the
document
Chapter 3. Writing Technical Documents © 2012 by Bedford/St. Martin's 8

9. What is editing?
Editing is the process of checking the draft to
improve its grammar, punctuation, style, usage,
diction (word choice), and mechanics (such as
use of numbers and abbreviations).
Chapter 3. Writing Technical Documents © 2012 by Bedford/St. Martin's 9

10. What is proofreading?
Proofreading is the process of checking to
make sure you have typed what you meant to
type.
Chapter 3. Writing Technical Documents © 2012 by Bedford/St. Martin's 10