Technical Writing Workshop

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 and editing.

Workshop summary

The virtual workshop is 90 minutes, including 45 minutes of interactive lecture and 45 minutes of hands-on exercises.

The agenda is:

1. How to get started
2. Put steps in order
3. Write clearly
4. Follow a formula
5. Self-Edit

Exercise 1: Create a task and task steps

Time: 15 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.

• Exercise 1.1: create the task steps for a predefined task.
• Exercise 1.2: order predefined task steps and then create the specific task.

If you are more comfortable working with UIs, here are the two alternative tasks.

• Exercise 1.1b: create the task steps for a predefined task.
• Exercise 1.2b: order predefined task steps and then create the specific task.

Exercise 2: Write clearly

Time: 10 minutes

The goal of this exercise is to practice clear and concise writing.

• Exercise 2.1: update a long sentence into 2 or more short sentences.

Exercise 3: Edit

Time: 20 minutes

The goal of this exercise is to become familiar with the style guide and editing process.

• Exercise 3.1: edit two tutorial snippets.