Home

 

Training

Schedule

Training prices

Student reviews

Finding our RTP (Raleigh/Durham, NC) training facility

 

On this page:

Prerequisites

Syllabus

Comments from students

Customizing this class

 

 

 

 

 

 

 


Check out our book, Technical Writing 101.

 

Technical Writing 101

(3 days)

We offer this class only as a private class; please contact training@scriptorium.com for pricing and details.


Technical Writing 101 is an intensive introduction to the basics of technical writing. It includes the following major topics:

*

Writing task-oriented documentation

*

Technical editing

*

Indexing

The course is intended for anyone who wants a solid understanding of basic technical writing, including:

*

New technical writers

*

People considering making a career change to technical writing

*

Technical professionals and workers who are not writers by trade but who must document their work (for example, engineers, programmers, scientists, technicians, process specialists)

See students' comments about Technical Writing 101.

Prerequisites

This course is for individuals who meet the following prerequisites:

*

Solid knowledge of a word processor, such as Word or WordPerfect

*

Proficient with Windows, Macintosh, UNIX, or Linux operating system

Syllabus

The class format includes lectures and hands-on exercises. Students also receive a copy of Technical Writing 101: A Real-World Guide to Planning and Writing Technical Documentation.

What is technical writing?

Overview

* Major differences between technical and other forms of writing * What's a spec?
* Documentation standards * What? There's no spec?
* Parts of a "typical" book * Know your audience
* What is task-oriented documentation? * Delivery media
* Creating a task-oriented outline * The Tech Writer's Toolbox

Editing and indexing

Editing

* Technical editing vs. copy editing vs. production editing * Editing checklists
* Style guides * Time constraints--when reality rears its ugly head
* Your editor is your friend (really!)    

Indexing

* Basic requirements of the technical end user * Building a usable index
* The purpose of an index * Cross-references
* Indexing conventions * Implementation issues

What do course participants have to say about the class?

I really feel like I'm walking away from this a better tech writer, a better editor of my own work, and with a clearer view of the importance of the craft.

[The training supplement] is very valuable because it contains many of the things I always wanted to know but always was much too embarrassed to ask.

I really enjoyed the Tech Writing 101 class. I have found it recently quite helpful in organizing my thoughts and paring down my language. Though the project I'm working on is only half done, I will generate a much more usable book.

Customizing this class

We can customize this class to meet the needs of your project team and deliver it as a private class at your location or ours. For example, we can focus on tips and trends in software documentation or conventions in medical writing.

To inquire about a customized version of this class, please send a note to training@scriptorium.com including a description of the special topics you'd like covered and the dates you'd like the class taught. Generally, you should request a customized class at least 6 weeks in advance, although occasionally we can deliver custom classes sooner, depending on instructor availability.

Copyright © 2000-2004 Scriptorium Publishing Services, Inc. All rights reserved.
Last modified on November 16, 2005 .