API Documentation

Share this post

API Documentation - #01

apidocumentation.substack.com

Discover more from API Documentation

Receive tips on Technical Writing, Developer Experience (DX), and Docs-as-Code.
Continue reading
Sign in

API Documentation - #01

Highlights: Developer Portals + Chat Bots, Designing delightful CLIs and APIs, What makes great documentation.

David Garcia
Aug 30, 2020
2
Share this post

API Documentation - #01

apidocumentation.substack.com
Share

Technical Writing

πŸ“How to successfully migrate docs to a new tool - Brooke Wayne defined a seven-step process to help you prepare, anticipate, and overcome anything that arises during your migration.

πŸ–ΌοΈ What makes a great API Documentation - DecathlonDev shared a checklist with the secret recipe for great documentation.

πŸ“ Processes for managing SDK releases - Tom Johnson shared a few callouts that you should look for before publishing SDKs and other code artifacts.

πŸ“Introducing GitHub’s OpenAPI description - GitHub has open-sourced an OpenAPI description of the REST API with +600 operations exposed.

Developer Experience

πŸ“Doing APIs right and doing right APIs - Arnaud Lauret recaps the contents of INTERFACE, by apidays conference on API architecture, design, governance.

πŸ“10 design principles for delightful CLIs - Natalie Johnson shared 10 principles for designing kick-ass CLI tools.

πŸ“ Making developer portals chatty with OpenAPI Bot - Thomas Bush from Nordic APIs showcased how developers can learn about web APIs by speaking to a chatbot.

Docs-As-Code

πŸ“ Previewing documentation in pull requests - David Garcia wrote a guide explaining how to build docs previews automatically every time a repository receives a new pull-request.

πŸ“Protect access to a Netlify site via GitHub Actions - Abdessalam Benharira wrote a guide to password protect sites hosted on Netlify.

2
Share this post

API Documentation - #01

apidocumentation.substack.com
Share
Comments
Top
New

No posts

Ready for more?

Β© 2023 David Garcia
Privacy βˆ™ Terms βˆ™ Collection notice
Start WritingGet the app
Substack is the home for great writing