Home About Contact Podcasts Writer River WordPress Consulting Advertising

Reader Question — How Do I Get Training in Technical Writing?

August 3rd, 2008 | Posted in Answering Questions, Technical Writing |

Jara writes,

I am so glad that I found your blog. I truly need an advice. Initially I got accepted as computer science and business major, however I did not see myself stimulated by it.

So I changed to International Relations and Development studies, something I always wanted to study.

But now, I am faced with few job prospects. Even though I left to work as a reporter in the UAE. I love writing. But it is quite a competitive, still market and I wanted to go back to Canada, one year in the UAE was way too much for me.

Now I want to pursue technical writing as a career. I am motivated, since I am a hybrid between science and arts, and it will enhance my pay.

But I want to be trained as a technical writer, I have about 4 computer science credits, I know rudimentary computer science concepts, though  C ++ is something I can vaguely recall.

I really need your advice on this.

Are there any internships for technical writing positions? What can I do? And what are the computer software programs I need to know?

And I am a fellow blogger as well.

My best regards :)

Jara, thanks for writing. It’s good that you have skills in both computers and writing. That combination  provides a great foundation for a career in technical writing. You don’t have to be a computer programmer to land a job as a technical writer, unless you plan to write documentation for programmers. However, any programming knowledge comes in handy.

To get training in technical writing, you have several options:

  • Land an entry-level job in technical writing and learn the skills you need on the job.
  • Earn a degree in technical writing somewhere
  • Serve as an intern for a tech pubs department
  • Create a portfolio of technical publications samples on your own

Any of these options can work well to move you forward into a career of technical writing. I took the first route: on-the-job-training. I’d been a writing instructor at a university, then a copywriter, and I wanted to move into technical writing. I landed a job as a technical writer at a financial company, and learned their style guide and methods. It was an excellent way to gain experience in technical writing.

Many companies want to hire candidates who already have experience in technical writing. It can seem like a Catch-22: you need experience in technical writing before you can get a job in technical writing; but the only way to get experience in technical writing is to have a job as a technical writer.

Actually, the Catch-22 situation is somewhat of a myth, one that many can’t see past. You most likely learned to write before you landed a job as a reporter. And how did you learn to write? Did the skills come only from on-the-job training? No. Most likely you wrote in your own spare time, developed writing skills, and then submitted some impressive writing samples to an employer, who hired you.

Technical writing can be the same way. If you want to learn technical writing, do technical writing. If you need a project, I recommend writing documentation for WordPress. (If you’re interested in that, I’ll give you more specific suggestions on areas that need better documentation.) Documenting WordPress may not interest you, but there are a hundred other applications you can write help for. Open source apps are the ripest.

As you tackle an actual project, you’ll be faced with stylistic questions. You’ll have to decide how to approach it, the language and format. I recommend that you open a sample how-to guide from some application you’re familiar with (even Microsoft Word), and try to imitate the style. Number the steps. Include screenshots where the steps are confusing. Chunk the material into tasks. See my post on the complexity of simplicity for some standard techniques.

You’ll also need a mentor, someone who can review your content and give you feedback. Here’s where the STC comes in. The Society for Technical Communication (STC) most likely has a chapter in your area. Go to the next local STC meeting or contact the local president. Ask for a mentor to provide feedback on your technical documentation.

In a thriving chapter, many people will be more than willing to volunteer. Take your mentor’s advice and shape your samples into professional-looking work. If you can produce several samples of help material for different projects, that alone may convince a hiring manager that you have experience in technical writing.

One thing I haven’t mentioned is tools. This is where it gets a bit controversial, but I’ll tell you what I use. I author almost everything in Madcap Flare. Using Flare, I generate both webhelp and a Word output, which becomes a printed PDF manual. I mainly use SnagIt to capture screenshots, although sometimes advanced tweaking requires me to use Photoshop. If I plan to make video tutorials, I use Camtasia Studio. Learning at least Flare and SnagIt will take you a long way.

If you know the specific job you want, you can inquire about their toolset. Maybe they’re die-hard RoboHelp users. If so, learn RoboHelp. Maybe they do everything in Microsoft Word. Fine, master styles and templates in Word. Perhaps they’ve moved to DITA. In that case, get to know an XML editor and the DITA Open Toolkit. Or maybe it’s a Framemaker shop. So dig into that.

Some employers require you to know their tool before they’ll consider you. Realize that “knowing” a tool has gradations of interpretation. With some tools, I can say that I “know” them, although I only know them as a novice. With other tools, I’m an expert. There are gradations of ability for every tool, so even if you only figure out Flare enough to create a basic online help file, you can still say that you “know Flare.”

It’s a bit ridiculous for an employer to expect each candidate to have an expert level of knowledge in every tool (e.g., AuthorIt, RoboHelp, Doc to Help, Flare, DITA, Framemaker, Word, Captivate, Camtasia, Photoshop, Dreamweaver, and others). It’s more important that you’re able to learn the tools the company wants you to use. You’d think this characteristic would be a given, but many technical writers get unnerved if forced to learn a new tool.

Readers, if you have advice to add, please do so in the comments below.

For more information on technical writing careers, see this post by John Hewitt on the Technical Writing FAQ.

RSS Subscribe


Related Posts

Tags: , , , , ,


Comments

You can leave a response, or trackback from your own site.

13 Responses to “Reader Question — How Do I Get Training in Technical Writing?”

  1. Its amazing how similar my toolset is to this. I started out as a pretty advanced user of Word, managing 200 page docs in Word. Completely overhauling single,large, unstyled reference documents created by technical developers into styled, manageable, structured documents, that are smaller, easier to maintain and print better. I use snagit for scrolling windows, but if i don’t have it, i rever to the freeware options like Screenshot Captor that does all the keyboard shortcuts and basic captioning and cropping thats required. We use Camtasia studio and encourage developers to make clever use of it from time to time.

  2. Did i say that as of today we try to use Flare and Lingo for as much of the professional end-user help/training like helps systems, install guides and system specs. I’ve managed a compiled set of 26 Word-based training documents in previous years, but maintainenance, template/content reuse was frustrating and time consuming but we did it anway.

    Flare and Lingo simplifies the workflow once you get the hang of it. IMHO, there are quite a few things that Word does better, but there are certain ‘affordances’ that Flare and MadCap Lingo, when used together, have absolutely no match, not even in RoboHelp, Doc to Help, Quark Express, or FrameMaker offer especially if you are looking at the long term maintenance side of information development.

  3. What specific sections of the Wordpress documentation do you feel could use the most help?

  4. Best bet — come back to Canada, to Vancouver. Take the short BCIT part-time tech writing course. Then off to bctechnology.com to find one of the many many many open jobs in the area.

  5. I’d really like a better explanation of the Add Media buttons. There are 4 of them, but they all bring up the same dialog box. And exactly what do I do to get the captions style applied to my photos (like in the default theme? The installation and upgrading instructions could be simplified quite a bit so they aren’t so intimidating. Also, in many of the php tags, they explain the parameters, but don’t give enough examples. Sometimes I wish they had a lot more examples. Also, it’d be nice to know more about the styles in general. It seems like sometimes the wp_pages (or whatever) tag in the header works well and other times chokes when I convert it to a list of items.

    I guess I really don’t have too much that I’m struggling with. It’s just that from a tech author’s point of view, it looks quite disorganized and poorly written. Give me a 6 month sabbatical and 50K, and I could produce a really awesome looking set of help materials. Even so, once you finish packaging up the help for the WordPress core, there’s a zillion plugins, and tons of themes that all do things a little differently. Everything is changing all the time, so you need a whole team of writers full time to keep things up to date.

    I was reading an article today that recommended open source apps increase their training materials to compensate for the lack of professional design and usability.

    What about you? Does the WordPress documentation meet all your needs?

  6. @Daniel, thanks for sharing. Glad to hear we have much of the same tools. I’m pretty happy with Flare, but I think it still needs a lot of work in terms of usability. And there are quirks here and there.

  7. Tom,
    You’ve given a thoughtful and constructive answer to a tricky question. I’d say that the last method you suggest, that of developing your own portfolio, is a very useful suggestion for people in places where tech writing jobs and tech writing courses are thin on the ground.
    In the past, I have suggested to people that they invent their own projects to write about, but your suggestion of actually contributing to the documentation for an open source product is a much better idea.

    Davids last blog post..Hurrah for Dr Johnson

  8. I am probably biased entirely, as a I spent a great of time collaborating on this, but a good place to start learning about how to do technial writing is the Wikiversity Technical Writing course, which is referenced above.

    Alistair Reeces last blog post..User:Hadrian

  9. Alistair Reece Says:
  10. Thanks for the post
    Now a day there is a huge demand of technical writers. A person who have a good command over written English and know how to write for a particular article or a press release. If you know these aspects of writing then there are many opportunities available in market.

  11. Where Do You Get Professional Writing Experience?…

    A fledgling technical writer named Jara wrote into I’d Rather Be Writing about a common Catch-22 situation faced by anyone wanting to get professional experience in writing…I need experience to get a job, but I can’t get a job without…

  12. Hi, technical writers are also often tasked with technical illustration jobs. So if you are looking for any information around technical illustrations and some free tutorials, I can recommend to go to the PTC website and watch some of our free illustration tutorials: http://www.ptc.com/products/tutorials/tech_illustrations.htm

    Good luck for your career!
    Bettina

  13. good post.

    I have taken a university class in Technical writing, continuing studies courses in web writing, grammer, style etc.. done volunteer work as an newsletter editor and as an assistant at a non-profit magazine, I have an e-portfolio of writing samples, worked on communications teams, & done team writing. Most job ads qualifications cite a university degree in english or communications (or comp sci/engineering). I do have a university degree in social sciences as well as a continuing studies certificate in web development & multimedia.

    but my question is: how important are the actual credentials?

    I seem to be getting screened out because I don’t have the particular degree or traditional job title (I’m a library assistant).

Leave a Reply