Software Documentation

By Janice Karin

Lesson 1: What is Technical Writing?

Lesson summary

As you can see, technical writing is a complex process that involves a lot more than simply sitting down and putting pen to paper (or fingers to keyboard). The rest of this course will delve into many of the areas discussed here in more detail. By the time we're finished you should have an excellent understanding of the process from start to finish.

Print this Page Print this page


Previous Page  1  2  3  4  5  6  7 


Lessons

Introduction
Lesson 1: What is Technical Writing?
• Types of documentation
• The importance of audience
• The importance of word choice and consistent writing
• The importance of organization
• The importance of indexing
• The importance of editing and review
• Lesson summary
Lesson 2: The Importance of Audience
Lesson 3: The Importance of Word Choice and Consistent Writing
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