Technical Writing

Question 1

In this order, good technical documentation should be:

Answer 1

Correct –> Complete –> Usable –> Clear –> Consistent

Question 2

What is an SME?

Answer 2

Subject Matter Expert, used as a resource to gather technical information

Question 3

Being an excellent technical writer requires you to be like what profession?

Answer 3

Investigative journalist

Question 4

What are the five steps of technical writing?

Answer 4

Plan
Structure
Write
Review
Publish

Question 5

What should you fill out before writing a technical document?

Answer 5

A Technical Brief

Question 6

According to the Microsoft Manual of Style, how can you be inspirational?

Answer 6

By emphasizing what a user can do rather than what they can’t do.

Question 7

What must you let go of when writing technical documentation?

Answer 7

Your Ego

Question 8

What should you have an in-depth understanding of to write effective technical documentation?

Answer 8

Your readers

Question 9

In what order should you plan your production schedule?

Answer 9

Backwards

Question 10

What should you get to know intimately?

Answer 10

Your product

Question 11

What is the most difficult part of writing a draft?

Answer 11

Getting started

Question 12

What section should you start with when writing a document?

Answer 12

The easiest

Question 13

Why should you stop proofreading?

Answer 13

• When you start nitpicking about insignificant words
• You revise the revision of the revision of the revision
• You can’t stand to look at the document one more time