Software Documentation

By Janice Karin

Lesson 3: The Importance of Word Choice and Consistent Writing

Homework - optional reading and exercises

* Read Chapter 19 of your textbook, "Writing Clearly" * Read Chapter 18 of your textbook, "Style Guides: Not Just a Fashion Statement" * Choose your favorite technical book and read one chapter. Does that chapter maintain a constant voice? Does it use a consistent style? Is all of the terminology defined in the text? * Now choose a technical book you don't like and perform the same analysis. * Compare your two analyses. Was the book you like more consistent than the one you don't?

Print this Page Print this page


Previous Page  1  2  3  4  5  6 


Lessons

Introduction
Lesson 1: What is Technical Writing?
Lesson 2: The Importance of Audience
Lesson 3: The Importance of Word Choice and Consistent Writing
• Exercise proper word choice
• Use short active sentences
• Use a consistent voice
• Develop a consistent style
• Maintain consistency in collaborative projects
• Homework - optional reading and exercises
Lesson 4: Writing Procedures
Lesson 5: Using Tables and Graphics
Lesson 6: Indexing Your Documents
Lesson 7: Editing And Reviews
Lesson 8: The Tools of the Trade