What is it like to be a Technical Writer?

I did a co-op term as a technical writer at a high tech company here in Waterloo.

dilbert cartoon tech writer

The job of a technical writer varies from company to company, but essentially it involves writing text that allows customers to understand how to use technology. In my case I was documenting software changes, and the process went something like this:

  1. Receive an assignment. Look into the software developers’ records to determine the nature of the change. This requires a bit of detective work, including emailing or discussing the changes with the person who wrote the code.
  2. Try out the new feature in a sandbox, or test site. This allows a technical writer to experience what a user would when encountering the interface for the first time.
  3. Write up instructions to help users understand how to use the feature. This can involve condensing a page of documentation down to five or six steps. It takes longer than you might think and requires many rewrites and double checking on the test site. It also involves some critical thinking about the words we use to describe things. The instructions have to be clear, unambiguous, and very concise.
  4. After creating the instructions, send them back to the developer for a technical review to make sure you got all the steps right.
  5. Send the instructions to another technical writer for peer review. Spelling, grammar, formatting, clarity, and adherence to the company’s style guide are carefully checked.
  6. Enter the information into the content management system to be published and made available to clients. Double check and triple check that the copy is clean.

Technical writing requires resourcefulness, excellent research skills, precision, attention to detail, and a familiarity with various single-source publishers. In some ways it’s similar to academic writing and draws on the same skills we’ve been honing throughout our school careers. But in other ways it’s very different. The creativity comes not from expanding on original ideas, but from synthesizing a lot of information and distilling it down to the finest point possible.

technical writing and critical thinking

Source

In my department people came to technical writing from various different backgrounds – English, music, engineering, French, and professional writing programs. It’s a job that comes up regularly in JobMine. Give it a try, no matter what discipline you’re coming from!

Blog topics

  1. 2020 (19)
    1. October (1)
    2. September (1)
    3. August (3)
    4. July (3)
    5. June (5)
    6. May (3)
    7. April (1)
    8. March (1)
    9. January (1)
  2. 2019 (26)
    1. November (1)
    2. July (1)
    3. June (1)
    4. May (4)
    5. April (5)
    6. March (4)
    7. February (5)
    8. January (5)
  3. 2018 (49)
    1. December (3)
    2. November (4)
    3. October (4)
    4. September (3)
    5. August (4)
    6. July (4)
    7. June (5)
    8. May (5)
    9. April (4)
    10. March (4)
    11. February (4)
    12. January (5)
  4. 2017 (28)
    1. November (2)
    2. October (1)
    3. August (4)
    4. July (4)
    5. June (3)
    6. May (1)
    7. April (3)
    8. March (4)
    9. February (4)
    10. January (2)
  5. 2016 (37)
    1. December (2)
    2. November (6)
    3. October (5)
    4. September (4)
    5. July (3)
    6. June (1)
    7. April (3)
    8. March (5)
    9. February (7)
    10. January (1)
  6. 2015 (20)