Difference Between Operations Manuals & Procedures Guides

What’s the difference between an Operations Manual and a Procedures Guide? At first glance, it’s easy to see the confusion as both contain procedures that need to be followed. However, if we look at them a little more closely, we can where and how they differ. Operations Manuals v Procedures Guides Samantha emailed me to […]

Difference between Procedures and Work Instructions

There is an argument in the office right now about the difference between Procedures and Work Instructions. I’ll give you my take later but wanted to run one definition by you first.

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. […]