This course was created with the
course builder. Create your online course today.
Start now
Create your course
with
Autoplay
Autocomplete
Previous Lesson
Complete and Continue
API Documentation for Developers
Introduction
Welcome!👐 (6:02)
Building a Documentation Mindset
Content and Presentation (8:47)
Reference and Conceptual Documentation (7:45)
Setting Expectations (13:57)
Real-world Patterns 1: Developer Home (5:45)
Real-world Patterns 2: Reference Docs (12:07)
Real-world Patterns 3: Dynamism and Examples (7:42)
Real-world Patterns 4: Interactivity and Machine-readable documentation (10:07)
Real-world Patterns 5: Timestamps and more (8:28)
Summary
Designing a Documentation Workflow
Why Design? (10:01)
Gathering Requirements (17:16)
Designing for Maintainability (5:43)
Common Approaches and Tools Part 1 (8:57)
Common Approaches and Tools Part 2 (18:56)
Coming up with a Workflow (18:26)
More examples (21:20)
Summary
Doing It!
Setting up (11:54)
Documenting at the API Level (19:59)
Documenting at the Endpoint Level (20:38)
[Case Study 2/Weblo] Setting Up (11:37)
[Case Study 2/Weblo] Writing the Documentation (21:19)
[Case Study 3/Pantheon] Setting Up (23:29)
[Case Study 3/Pantheon] Writing the Reference Documentation (18:05)
[Case Study 3/Pantheon] Writing the Conceptual Documentation (16:51)
[Case Study 3/Pantheon] Testing the Documentation (17:11)
Wrapping Up😅 (8:07)
Wrapping Up😅
Useful Links
Alternatives to writing your OpenAPI spec by hand
.
This article
gives a good overview of some techniques for designing and writing API documentation.
Complete and Continue
Discussion
0
comments
Load more
0 comments