Software Documentation

By Janice Karin

Lesson 4: Writing Procedures

Homework - optional

* Write a procedure outlining how to make a paper airplane.
* Give your instructions to someone else and ask them to make a paper airplane by strictly following your instructions
* If the resulting airplane doesn't look like you expected it to, try again until your instructions are correct

Print this Page Print this page


Previous Page  1  2  3  4  5  6  7  8 


Lessons

Introduction
Lesson 1: What is Technical Writing?
Lesson 2: The Importance of Audience
Lesson 3: The Importance of Word Choice and Consistent Writing
Lesson 4: Writing Procedures
• Use active language
• Use short phrases and sentences
• Use ordered lists
• Provide one instruction per step
• Be consistent
• Perform the acts you're describing
• Lesson Summary
• Homework - optional
Lesson 5: Using Tables and Graphics
Lesson 6: Indexing Your Documents
Lesson 7: Editing And Reviews
Lesson 8: The Tools of the Trade