What should I study first?

What should I study first?

August 13, 2022 Comments Off on What should I study first? By akredshaw@gmail.com

If you want to get a job as a technical writer, you will have to get technical. Since I’m often asked what to study first, I’ve put together some guiding principles so you can figure out where to spend your time learning the technical subjects. 

I won’t tell you what to study first, but I’ll give you what you need to make that decision. As usual, I’m assuming you want to document software using a docs-as-code approach, which is where my experience lies. 

For minimum requirements to get a job as a technical writer, see the first section of Getting experience – Part 1

If you have a technical background

If you have a degree in computer science, or you have been a software developer in the past, you don’t need as much practice with the technology as you do writing and thinking like a technical writer. What would probably help you the most is a technical writing certification. It may be from a college or other institution. A certification will demonstrate to employers that you not only know something about writing, but that you have the skill to write technical documentation. It also proves you are interested in technical writing as a career. I mention this because some employers will assume that since programming pays more, you will end up doing that instead of technical writing. Completing such a certification shows you are serious about this profession. 

If there are some items you don’t know on the list below, go ahead and learn them as well.

If you don’t have a technical background

This is for all of you with a BA in English, Art, Social Science, etc. You will have to put a heavy emphasis on learning the technology to get into technical writing. Here’s what you need to learn.

List of technology to learn to be a technical writer

  • A programming language – just the basics
  • Git
  • Command line
  • HTML
  • Markdown
  • Web API documentation
    • OpenAPI specs
TechnologyDifficultyEstimated time to learnNotes & resources
Programming languageHard2-4 monthsOnly at a basic level. Here is some guidance on learning a programming language.
GitMedium1 monthLearn this through githowto.com. Out of the 51 lessons, the first 28 will be the most useful.
Command lineMedium2-4 weeksDepending on your OS, go to YouTube and type of the the following:learn command line for Windowslearn command line for Mac OSlearn command line for LinuxThere are a lot of good videos out there.
HTMLMedium3 weeksThere are probably a million HTML tutorials online. Learn the basics, plus how to create tables.
MarkdownEasy2 hrsThis is really easy. Learn it with Markdown Live Preview.
Web API documentationHard3 monthsSee Documenting APIs from Tom Johnson. There are several Udemy courses on this topic you can buy as well.
OpenAPI specs
(Part of web API documentation)
Hard1 monthOnly 1 month if you already know web API documentation basics. See Step-by-step OpenAPI code tutorial.

In order of importance (just the numbers)

If you use my spreadsheet for job results in my area, you’ll see a number of jobs results for each skill.

  1. API = 26
  2. HTML = 23
  3. Markdown = 22
  4. Python = 20
  5. Git = 15
  6. OpenAPI = 2

Notice that rather than include “programming languages” in the list, I listed “Python” instead. The reason is because if I wrote “programming languages,” phrases like “know a language such as Python” would be excluded. If I did not put it in quotes, it would look for the words programming and language, but not necessarily together. Anyway, Python comes up the most often in the list when they ask for experience with a programming language.

In order of importance (my view)

Here’s my view of what is most important to study. You’ll notice some differences. This is a bit subjective, but I do have reasons. The reason I did not put APIs at the top is because although API documentation is listed fairly often, it is less common for it to show up in actual interview tests. In all the companies I’ve interviews with, I think they tested me on APIs twice. None of those were FAANG (Facebook, Apple, Amazon, Netflix, Google) companies, by the way. Whereas, all the FAANG companies, and several others I’ve interviewed with, had me read code in a programming language and tell them what it does.

What do employers tend to focus on the most in interviews? What’s highest on their list? Here is an estimate from my experience in the San Francisco Bay Area, interviewing at many of the top companies, including most of the FAANG companies. 

  1. Programming language
  2. Web API documentation
  3. Git
  4. Command line
  5. Markdown
  6. HTML
  7. OpenAPI specs

Some things to keep in mind

You may imagine that you want to spend all your time at the top of the list and work your way down, but remember, Markdown only takes a couple of hours to learn. In that case, even though it appears much further down, you probably want to get it done early in order to add it to your resume soon. 

Something else to consider is that learning some of these subjects can get tiring after an hour or so. You need breaks so your mind can remain fresh and you don’t get burned out. That’s why you probably want to be working on 2-3 of these items at a time. When you get tired of learning programming, you can play with Git for a while. And then maybe HTML. This way you learn more in less time, and don’t get burned out on any one subject.

You should also know that if you start learning API documentation in any depth, you will learn the command line and possibly Git along the way, since these tools come up frequently when working with REST APIs. 

If you want to read more about what you can expect in a technical interview, read The technical writing interview – Part 2.

Happy learning!

Comments are closed