Search results

Learn the basics of technical writing (TW Job)

Series: How to get a job in technical writing

by Tom Johnson on Dec 18, 2009
categories: beginners

Before you can create a stunning portfolio or market yourself to companies as a technical writing intern, you need some grounding in the basics.

If you're in a college that offers a degree in technical writing (usually a degree in English with an emphasis in technical writing), by all means do it.

If I were doing it over, I would actually double-major in English and computer science. Some students prefer to get domain knowledge, such as in accounting or engineering, and then supplement that knowledge with writing skills.

Whatever your situation, learn the basics of technical communication. For starters, learn how to write well. Learn grammar. Learn to analyze an audience, create personas, approach documentation from a task-oriented perspective.

Learn to number your steps, keep your topic titles parallel, and be brief and concise. Learn to write useful instructions rather than obvious statements. Learn when to use screenshots and when to omit them. Learn the strengths and weaknesses of different help formats, such as wikis versus quick reference guides versus video tutorials. You can't do anything without first grounding yourself in the fundamentals.

You may not learn all of these concepts in your program. If not, you can supplement your program with some instruction from professionals in the field. The Society for Technical Communication (STC) has an excellent certification course from well-known professionals. You can also read the Intercom and Technical Communication Journal.

If you don't have money to join the STC, connect with someone who is a member and ask to borrow back issues. Read blogs and books published by professionals in the field (here's a list of foundation books). However you do it, get a solid education. This is critical before you can move forward.

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.