Mashape Blog

Rumors aboard Mashape's spaceship

Augusto Marietti
We came across this article by Jacob Kaplan-Moss titled “What to write“. The article shares some great tips on writing great technical documentation. We’ve reproduced some parts of the article and summarized some main points below which we think would be the most useful for Mashapers.

Formats of a technical documentation

A well-documented project needs to provide many different forms of documentation. At a high level, you can break down the different types of technical documentation you need to provide into three different formats: Step-by-step tutorials, Overviews and topical guides to the various conceptual areas of your project, …