Search results

Top 10 Most Frequently Asked Questions about Technical Writing

by Tom Johnson on Jan 17, 2013
categories: beginners • technical-writing

Through my blog, I receive a lot of questions from users.

I’ve seen the same questions numerous times, so I’ve decided to compile a list of answers to those questions and add a link to them on my contact page.

Charting your course in technical communication
Charting your course in technical communication

These are the 10 most frequently asked questions about technical writing:

1. What technical writing tools should I learn?

In general, learn markup and style languages more than a specific tool, since languages have a more widespread application than specific tools. The most useful markup and style languages are HTML, XML, and CSS. You can find resources to learn these languages online.

For specific tools, look at http://indeed.com for technical writer jobs in your area. After analyzing the job postings, try to identify a common trend in the tools required. Learn those tools. You can also review commonly used tools from previous WritersUA tool surveys.

In general, learn these four types of tools:

  • Help authoring tools (such as Jekyll, MadCap Flare, Confluence, Robohelp, Doc-to-Help, or some other)
  • Graphics tools (Snagit, Capture, Photoshop, Illustrator)
  • Video recording tools (Camtasia Studio, Screenflow, Captivate)
  • Page layout tool (InDesign, Word, Framemaker)

Even if you don’t know the exact tool the job requires, your proficiency with some of the above tools will give you credibility that you can learn the company’s specific toolset.

2. Should I get a technical writing degree or certificate?

If you’re in a position in life where education fits easily into your schedule, go for it. For example, if you have the time, money, and are interested in a degree, take advantage of the opportunity. Once you settle down in life with kids, a job, and other commitments, it can be really hard to get that masters degree in tech comm.

However, a technical communication degree or certificate isn’t necessary to get a job in technical writing. If you’re not in a life situation where education fits easily into your schedule and pocketbook, don’t worry about it. Few professional technical writers have degrees or certificates specifically in technical communication anyway.

Instead, focus your efforts in developing a strong portfolio with examples that demonstrate your knowledge and skills. (By the way, even if you do pursue higher education in technical communication, you will still need a portfolio to get a job.)

For more information, see the following:

3. How do I get a job in technical writing without experience?

If you don’t have any experience, volunteer your technical writing skills with an open source application, such as WordPress. For example, you could rewrite or add information in the WordPress Codex. Alternatively, you could create instructions for a product you use, such as your phone or camera.

The exact product doesn’t so matter much. Interviewers will be interested to see your writing style, your ability to articulate complex concepts, your mastery of advanced tools to author the information, your sense of organization and detail, and more.

For more information on landing a technical writing job, see my series on How to Get a Job in Technical Writing.

4. I’m interested in technical writing, but isn’t it boring?

No, technical writing isn’t boring. It actually taps into quite a few creative skills, but that creativity isn’t creativity so much in writing. It’s more like creativity in problem solving, layout and design, finding ways to illustrate concepts, and in thinking through ways that people might use the product.

In addition to using these creative skills, you’ll be immersed in an environment full of interaction designers, engineers, quality assurance testers, project managers, analysts, corporate communications teams, and more. In short, IT departments can be energetic, cool places to work.

At the very least, give technical writing a try. If you find it boring, switch to something else.

For more details, see the following:

5. Would I be good technical writer? I don’t have a background in technology or writing.

Most tech writers don’t have a specific background in technical writing. You will be a good tech writer if you have any of the following qualities:

  • You’re a good problem solver.
  • You’re patient (e.g., when you run into technical problems, you don’t throw your mouse across the room).
  • You’re tech savvy.
  • You’re a gadget person.
  • You like interviewing and talking with people.
  • You like writing and language.
  • You like figuring out how things work.
  • You like layout, design, and visuals.

6. I don’t have money to buy the tools, but all technical writer jobs seem to require knowledge of these tools.

I use an open source tool called Jekyll. This is a static site generator that helps you build HTML quickly and push out websites. If you’re interested in this approach, you can try the free Jekyll theme I developed specifically for documentation projects.

You could purchase academic versions of the software for usually half price or less. For example, you can buy an academic license to MadCap Flare for $500. Most Adobe products have similar academic discounts.

If you consider the cost of software to be equivalent to buying books for class and paying tuition, the cost is more understandable. (Note that academic software restricts you from using the software commercially.)

You could also download trial versions of the software. The trials usually end after 30 days, so you have a limited opportunity to learn the software during this time. You could reformat your computer every 30 days and install new trial versions, but doing so would skirt around the idea of a trial, in addition to being a major pain.

You could try using open source substitutes, but I don’t recommend this method, because usually employers look for knowledge of specific tools, usually industry standard ones. When you invest so much time and energy in learning a software tool, you want this time investment to have a significant return.

Employers want prospective employees to know industry standard tools such as Photoshop rather than Gimp, Microsoft Word rather than Open Office, Camtasia Studio rather than Camstudio, and so on. However, if open source is your only option, it’s better than nothing.

7. Could I get a job as a remote tech writer working from home?

If you’re new to the field, you probably won’t find a remote technical writing contract. Usually you need more experience before employers will trust you to work from home. Even so, many employers want you to be on site at least part of the time.

8. What exactly do technical writers do?

Technical writers do a variety of tasks, including some or all of the following:

  • Explore products and analyze requirements data enough to become an expert about the product.
  • Interview and meet with subject matter experts in regular meetings and one-on-one situations to ask questions and learn more about products.
  • Create instructions on how to use software applications and hardware products.
  • Create illustrations, diagrams, and other visuals that explain technical concepts.
  • Record video tutorials that show how to use technical products.
  • Relay user feedback to product teams on how to improve the products, whether that feedback comes through usability testing, training, or other user immersion.
  • Create elearning courses and simulations for users to learn products.
  • Create technology how-to articles for marketing efforts to increase awareness and adoption of technology products.

9. I have an assignment to interview a technical writer. Can I send you my list of questions?

Sorry, but I usually don’t have the bandwidth to respond at length for this. However, you could probably find a technical communicator willing to respond if you asked around on Twitter and included the hashtag #techcomm. If someone does respond and is interested in posting their responses as a guest post on my blog, I would love to do that.

10. How can I get a job as a technical writer?

Getting your first job as a technical writer is usually the hardest job to get, but the jobs once you’re established in the field become much easier. Follow these seven steps to get a job as a technical writer:

  1. Build up your knowledge of tools and languages. For example, learn CSS, HTML, and XML. Also learn a help authoring tool, a graphics tool, a video recording tool, and a page layout tool.
  2. Create a portfolio of sample technical writing deliverables. For example, create an online help, a how-to guide, a quick start guide, and a video tutorial.
  3. If necessary, move to a city that has a lot of IT opportunities. Some popular cities are Seattle, San Jose, Austin, Boston, New York City, Denver, San Antonio, Chicago, Atlanta, Baltimore, Philadelphia, Minneapolis, Las Vegas, and many more. If you search on indeed.com for technical writer jobs, you’ll see a breakdown of available jobs by city. Also, if you look at previous cities the STC Summit has been held in, it usually indicates a high number of technical writers in the area. Basically any tech hub will have a lot of tech writing opportunities.
  4. Identify your strengths and build additional specializations. These specializations might include usability, video tutorials, information architecture, marketing, e-learning, content strategy, project management, or another hybrid skill.
  5. Start a blog to record insights and experiences about the field of tech comm. A blog will provide evidence of your knowledge, show your enthusiasm for the field, and let employers get a feel for your writing style, intelligence, and engagement.
  6. Research the companies you want to work for, and identify a good fit for your skills. After you research the companies, create a custom cover letter that presents a case for why you would make such a good fit for the company. Although custom cover letters take time to create, they can be a powerful example of your writing skills. Taking the time to write a custom cover letter will certainly get the attention of a prospective employer.
  7. Apply for the jobs. There are a lot of job sites (Monster, Dice, Yahoo, and more). I like Indeed.com because it consolidates job listings from multiple sites.

About Tom Johnson

Tom Johnson

I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, plain language, tech comm careers, and more. Check out my API documentation course if you're looking for more info about documenting APIs. Or see my posts on AI and AI course section for more on the latest in AI and tech comm.

If you're a technical writer and want to keep on top of the latest trends in the tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.

© 2024 Tom Johnson