Documentation/API documentation/Tutorials and guides
 | This page is currently a draft.
|
Quick start
[edit]The quick start is a specific type of tutorial.
Resources to help you write it:
- The Good Docs Project guide and template
- "API getting started tutorial" from the Learn API docs course
Authentication
[edit]An authentication guide provides direct and straightforward instructions for:
- How to create client credentials
- How to generate an API key or access token
- How to authenticate your requests
- How and when users will need to refresh their access token
- Link to explanation of error messages that indicate authentication issues
While you may include some of these steps in your quick start tutorial, they should also be available as a quickly accessible and easy-to-find standalone guide. Consider transcluding the authentication steps in your quick start tutorial instead of duplicating the information.
Resources to help you write it:
Other tutorials and guides
[edit]The other types of tutorials and guides you should include in your API documentation are specific to your API and its features. Consider which types of data you might want to emphasize, common issues or confusing behavior your users might encounter, or frequent use cases you want to support.
For help writing those pages, refer to:
- The general tutorial template and the examples linked there
- The general how-to guide template and the examples linked there