It’s a concise reference manual containing all the information required to work with the API, with details about the functions, classes, return types, arguments and more, supported by tutorials and examples.
How do you write API reference?
- “API”
- “Reference”
- Name of API (e.g. “Web Audio API”)
- Any pertinent related keywords (e.g. “audio”)
What makes a good API documentation?
As such, good documentation should be clear and concise, but also visual, providing the following: A clear explanation of what the method/resource does. Call-outs that share important information with developers, including warnings and errors. A sample call with the correlating media type body.
