TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Selling a team on the technical writing job role From:"nita daniel" <ndaniel -at- gmail -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Fri, 9 Feb 2007 13:29:43 -0600
Hello,
I need to educate my team on how to use me. We're on a newish project,
and our methodology for our ongoing work is still evolving as we make
discoveries. I'm going to talk about it in our weekly meeting. I'm
like a new, versatile kitchen gadget that they just don't know what to
do with.
And along those lines, I was thinking of giving them a
"congratulations on your acquisition of a technical writer!" sheet.
So I'm looking for ideas on goofy things to include in that. But also
useful information. When to get me involved. Why to get me involved.
And maybe a little bit of what to expect.
As far as when, frequently people see a need and start a brain dump
into a word document. So, keeping that in mind, my brainstorm has
yielded the following prompts to get a technical writer involved:
* When you need something written
* When you decide this is information other people could use
* The third time you revise something
* When you have trouble figuring out how to say something
* When you solicit input from others or collaborate
* When you can't make a program display something the way you want to
As far as why?
* I have specific software skills
* I have specific conceptual and document organization skills
* I have specific writing skills
* I have specific software tools
* Documentation that "looks pretty" is easier to skim, easier to
understand, and puts the user in an emotional space to absorb the
information
* Free your time
What to expect?
* I don't care if you misspell things or use funky grammar or
punctuation. I'm interested in the actual information you have in your
noggin.
* While I expect blunt criticism of the efficacy and accuracy of my
work, my own feedback is of a more human scale
* Expect documentation to be consistent
* Expect to have more time to focus on your own things
I know we've all found ourself in this situation. Have anything to
add? Phrasing to suggest?
Thanks,
Nita Daniel
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com