DEV Community

Charles Ndavu
Charles Ndavu

Posted on

Technical Writing Journey Part 2...

Previously in Part 1, I listed the areas to focus on, a beginner guide. However, it can be challenging to find a niche or specific area to tap into as a techie. Skills and experience determine which field of technical writing fits you, but I believe you need to learn the basics of that language, tools, and the writing guidelines.

Above all, motivation is the aspect of success. Each techie is fighting for minimal spaces in big tech companies. I am too... As a beginner, API Documentation or Software Documentation seems like a 'fancy' field in technical writing.

Maybe or not. It depends if you have started making significant dollars. But as a beginner, you have to trust the current market trends and how experienced perceive the future to look like.

What is API Documentation

Google has a different definition of what API Documentation means. API Documentation is a manual, meaning it has the necessary instructions on using an API.

For example, an SMS API Documentation(sozuri.net) provides instructions on integrating the API into a website or a system developed in a particular programming language.

As a technical writer, your role is to write the developer coding language for even a less experienced developer or a technology enthusiast to understand the API's procedure.

Types of APIs

  • Web APIs.
  • Soap APIs.
  • Internal APIs.
  • REST APIs.
  • Composite APIs.
  • Partner APIs.

It is important to understand these types of APIS because they require specific formats when writing procedures.

hey! more input on the same is welcomed...

Top comments (0)