What does a technical writer ‘do’?

On occasion I get asked this question: “What does a technical writer actually do?”. Of course the answer depends on who’s asking and the context in which they are asking the question. But if you want to know about the sorts of things we do each day, then here are a selection of websites that describe our work better than I can:

• “So you want to be a technical writer?” (A light-hearted look at what makes a good technical writer from HCi Consulting)
  http://tinyurl.com/5qf39a
• “The tech writers manifesto” (Michael Bremer)
  http://www.untechnicalpress.com/manifesto.htm
• “What does a technical writer do?” (California Employment Development Department)
  http://www.calmis.cahwnet.gov/file/occguide/TECHWRTR.HTM
• “About technical writing” (David A. McMurrey)
  http://www.io.com/~hcexres/textbook/intro.html#about
• “What is technical communications?” (Sean Hower)
  http://www.sean-hower.com/downloads/whatIsTechComm.pdf
• “Getting started in technical writing” (Rhonda Bracey; PDF)
  http://tinyurl.com/6q2yfz

And then there’s this list from one of Joe Welinske’s talks at the AODC Conference earlier in 2008:

The User Assistance Skill Set:

• Writing (procedures, reference, wizards, embedded, UI)
• Editing (copy, technical, developmental)
• Task analysis
• SME interviewing (SME = subject matter expert)
• Indexing, Search
• Instructional design, eLearning
• Localization, translation
• Graphics development
• Information design
• Usability testing
• Quality assurance, testing
• Coding online Help (CHMs, web-based help)
• Coding web content (HTML, XML, CSS< JavaScript, Flash)
• Programming (C++, Perl, Ajax)

(I think I’ve done many of those at various times except the Programming and Localization/translation stuff.)

Update June 2009: BJ on the Lone Writer SIG email discussion list asked her list colleagues to contribute to a list of “What a technical writer does”. These were some of those added:

• Career information for high school students:
  http://www.istc.org.uk/Downloads/Tech_comm/techwritercareer2008.pdf
• Gathers/extracts information from those who have it, then interprets and repurposes that information into a form suitable for the intended audience
• KB, another list colleague, said she particularly liked Andrea Ames’ approach: “I solve problems. I solve problems where people can’t figure out the next step in a process. I solve problems where people can’t agree on a process. I solve problems where people can’t remember the process, or where to find the documentation of a process.
  I do this by listening, by identifying consensus points, by establishing consensus, and documenting what was decided, then putting that information where all stakeholders can find it.”
• And then there’s Stuart R’s classic signature line: “Developers explain How the Product Works. Technical writers explain How to Work the Product.”

Update 17 June 2009: Ellis Pratt at CherryLeaf has just published “The Perfect Technical Author” at: http://www.cherryleaf.com/blog/2009/06/the-perfect-technical-author/

[Links last checked June 2009]