Creating API documentation and developer portals (beta)
-
Introduction (4:52)
-
What is an API? (23:39)
-
Using an API (23:28)
-
How APIs are created (1:24)
-
Authentication and accreditation (17:53)
-
What documentation should I write? (17:12)
-
The Overview section (7:04)
-
The Concepts section (2:16)
-
The Getting Started section (5:43)
-
The API Reference section (2:20)
-
Writing the API reference by hand (12:31)
-
Cookbooks (3:46)
-
Tutorial/Colab/Code labs (3:27)
-
One-pagers (1:23)
-
The Case Study section (2:21)
-
The FAQs/Troubleshooting section (2:08)
-
Cheat sheets (2:25)
-
Release notes (Changelog) (2:22)
-
Other content (3:13)
-
Onboarding (2:11)
-
Writing code samples (5:56)
-
Documentation - summary (1:18)
-
Design patterns in developer portals (14:52)
-
Authoring tools for API documentation (37:33)
-
Managing an API documentation project (17:53)
-
Summary (2:58)
