API-documentation tips for new writers

My 4 tips for writing API documentation for new writers.

1. You must understand the solution you are documenting. Play with the API until you are sure you know how it works.

2. In your documentation, explain each input parameter clearly. For example, do not just say the values for a parameter can be true or false. Explain what will happen when you set the value to true or false.

3. Document all the issues and their solutions while you play with the API. It will make a nice FAQ document to help your support team.

4. Sell your product! Remember that your document is an opportunity to convince potential clients that your product will make their lives easier.

[The author of this piece is Riaan De Villiers | Experienced Solution Consultant | www.linkedin.com/in/riaan-de-villiers]

Leave a Comment

Your email address will not be published.