API Documentation Best Practices – Full Course

This course covers everything you need to know to create, automate, and publish API documentation your developers, partners and users will love. You’ll also learn why API documentation is the foundation for strong governance, effective API security, and achieving your API business goals.

✏️ Course developed by Jason Harmon.

Resources:

⭐️ Contents ⭐️
0:00:00 Introduction
0:01:16 What is API Documentation?
0:54:02 The Business Impact of API Documentation
1:08:28 How to Write Good Documentation
1:36:03 Documentation Techniques and Tools
1:44:38 Documentation Best Practices

🎉 Thanks to our Champion and Sponsor supporters:
👾 davthecoder
👾 jedi-or-sith
👾 南宮千影
👾 Agustín Kussrow
👾 Nattira Maneerat
👾 Heather Wcislo
👾 Serhiy Kalinets
👾 Justin Hual
👾 Otis Morgan
👾 Oscar Rahnama

--

[nemeziz_prime]

You read my mind, I was just asking around in dev groups and forums as to how developers document their projects

[amanshahi]

Thanks, greatly admire the whole idea of teaching the documentation from scratch. Newbie Dev like me suck at this. Most tiresome job but you made it look super fun

[paulsingh]

Thanks for teaching what my university didn’t! Glad I learned Bio and Chem for Software Engineering

[ekeminios]

Thank you Jason, great teaching on API documentation

[trafalgarlaw]

Thanks for sharing very clearly about API Documentation.

[chandanveeppa]

This is the course I didn’t know I needed! Thanks for a detailed code on this crucial part of software development process.

[devrano]

Damn, I was looking for this, morning

[VivekKumarSinha]

Excellent video on API Documentation topic. However, there are some parts missing from the video, like video from 1:02:20 to 1:05:50 is missing where API Style Guides is discussed. Please fix this.

[holyshiett]

An old lab partner told me his company story involving his director making a bunch of teams take an course to learn formal documentation. Then the org made it a priority to document everything for the next sprint. At the end of the quarter, a majority were laid off lol.

[WriterThinkerDogger]

This is a fantastic course. Even though I have been working with API doc for years, I learned a lot. And I plan to share it with clients. Is there a cert for this? I thought I heard you say there was but somehow I missed the link.

[jananderson]

Right about at the 1 hr mark (2 Good docks matter for improved governance), your deck does not display. Several places throughout the video, the display blinked off/on but I thought it was my monitor. Guess it actually wasn't me! LOL

[laxmirani]

We need such courses in dev portal dev community and courses on api product management

[heraeth]

The fact after 4 months there is 27 (28 after me) comments proves nobody likes making documentation.