The three "R"s of Technical Writing

Technical writing is one of the hottest field in the tech industry at the moment and it is fair because without it, learning new things can be challenging. It is not always easy to find the best content about an API or a programming language an this is one aspect that makes the field complex. In this article, I will share what in my opinion contributes to writing good articles. I call them the three "R"s of Technical Writing. Great articles are:

  1. Relatable.

    Before writing that article, it is very important to establish a context and to do that, here are some tips.

    • Have your audience in mind - be intentional about whom this article is intended to. If you are documenting an API, know that most people in your audience are going to be developers.

    • Create a story that will get the audience's attention. It is always a good thing to let people know the genesis of a product. This helps to know whether or not this API is valid to a certain group of people or not.

  2. Readable

    Using the correct terminologies to explain a concept is a very important phase of technical writing and here is why.

    • It informs that the writer knows what they are talking about. Jargons can be complex to understand especially for new comers into the field but they are the approved way of conveying messages concerning a particular technology. Writers expose the terminologies and readers keep on learning.

    • It helps to determine the level of complexity of an article. This will reinforce the context and make the readers decide whether or not they should continue reading the content.

  3. Relevant

    When writing an article, it is important to ask whether or not the article will beat the test of time. If building a free API can be hard, let alone explaining it to the grand public. Here are some tips of how to remain relevant.

    • Connect with people who work on the product team and ask them questions about the product especially the stable version, the next release date and other important questions.

    • Update content whenever possible. Subscribe to the company's social media account and follow their pages. Writers must understand the market and move with it.

Technical writing is a wonderful field but like every other fields, it requires a lot of work and I hope this article is goin to help someone feel less intimidated and more encouraged to break into the industry.