This repository contains the writing and editing exercises for the Technical Writing Workshop. By the end of the workshop, you will understand best practices for:
- Technical writing
- Editing
- Instructional Design
The workshop is designed to be delivered in a 2 hour, virtual session. The session will include 1 hour of interactive lecture and 1 hour of lab work to be completed in groups or pairs.
The agenda is:
- How to get started
- Put steps in order
- Write clearly
- Follow a formula
- Edits
- Instructional design best practices
Time: 20 minutes
The goal of these exercises are to practice writing specific tasks and task steps. A well defined task and steps are key to creating a focused, well thought out tutorial.
- In exercise 1.1, you will create the task steps for a predefined task.
- In exercise 1.2, you will create three unique, specific tasks and then create the task steps for one of them.
Time: 20 minutes
The goal of these exercises are to practice clear and concise writing.
- In exercise 2.1, you will practice writing clearly by updating a long sample sentence into 2 or more short sentences.
- In exercise 2.1, you will write your own introduction composed or 3 - 6 short sentences.
Time: 20 minutes
The goal of this exercise is to become familiar with the style guide and editing process.
- In exercise 3.1, you will edit an entire tutorial.