Fundamentals of Technical Writing

Fundamentals of Technical Writing Module 1
The Technical Writing Discipline

In week one, we explore aspects of technical writing, including how to assess documents and audience. A technical writer essentially translates the hard-to-understand jargon of the technical field into something that is understood by the reader of the writing. We will also discuss preliminary steps that need to take place before writing begins, such as learning your subject matter and collecting information.

• What Does a Technical Writer Do?
• Technical Writing Jobs
• Preliminary Technical Writing Tasks
• Writing, Editing and Recognizing a Good Document
• Subject Matter

Fundamentals of Technical Writing Module 2
Clear Writing 

Quality information is created in technical writing when an early analysis is made of your entire presentation, which is best done with an outline. It involves organizing the information you gathered into a logical format detailing how you plan to organize the document. This week we will discuss initial planning phases and how to outline material. We will also explore various writing habits and methods, such as the KISS (Keep It Short and Simple) principle and international considerations concerning translations.

• Organizing Content
• Initial Draft
• Writing Habits
• Procedural Writing
• International Considerations

Fundamentals of Technical Writing Module 3
Illustrations and Editing 

Technical writers write, right? Yes, but technical writers also spend a significant amount of time handling visual items, such as graphics, illustrations, and photographs. Especially related to information available online, manipulating images is a huge aspect to a technical writer’s job. This week will examine the correlation between visuals and writing while exploring various types of illustrations. Also, we will explore the various aspects of how technical writing is edited, including information confirmation, style guidelines, and the difference between production editing, technical editing, and copy editing.

• Correlation Between Visuals and Writing
• Rich Media Graphics
• Style Guidelines
• Tech Writing Editing
• Reviews

Fundamentals of Technical Writing Module 4
Wrapping Up a Technical Document 

In a large document, there are certain items that need to be placed in specific locations throughout your pamphlet or book. In this module, we will review these items, whether they are in the front of your document, or in the back. We are also going to review editing and proofreading your writing, testing the document and finally, putting a freeze on your document. Also, if you want to grow with the future of technical writing, you must know web page design and understand the languages involved with creating online material. This week we will take a look at types of markup and publishing software.

• Front and Back Sections
• Editing and Rewriting
• Design
• Tools of the Trade
• Word Processing, Image and Markup Software