[How to] Write a Customization Guide

The first question is: who are you writing this customisation guide for? As a technical writer, the skill to developing a useful guide is to keep the reader in mind. Who will be reading this customisation guide? What’s the most important thing they need to know? How can I make this more helpful to them? […]

How To Write Technical Documentation For REST/Web APIs

Why write API reference documentation? If your company develops APIs, then you can provide reference documentation for each API available with the product. The API documentation should describe the common components used by each of the APIs for iOS, Android, and other platforms. Essentially, the API reference documentation explains the data structures available through the APIs. […]