Loading…
Nashville, TN
September 24 - 26, 2018
Click Here For Information & Registration
Back To Schedule
Wednesday, September 26 • 11:40am - 12:00pm
Minimum Viable Documentation for RESTful APIs - Mike Jang, ForgeRock

Sign up or log in to save this to your schedule, view media, leave feedback and see who's attending!

Tweet Share
Feedback form is now closed.
To paraphrase a James Bond movie, "Swagger is not enough".

You've done the work to set up OpenAPI specification REST calls for your APIs (Inaccurately known as Swagger). You have reference information. But you discover that few users are actually trying REST calls on your system. You're wondering: "What else do I need?"

This presentation will describe the Minimal Viable Documentation (MVD) for RESTful APIs, also known as "What do I need for my developer portal?"

Based loosely on Kristof Van Tomme's presentations on Developer Experience, Mike will describe the MVD for a developer portal, what will help your developers try out your APIs.

Mike will discuss characteristics of:

* `Landing Pages` that describe the API
* `Tutorials` that help the user get started
* `Details`, or reference information satisfied by the OpenAPI specification
* `Work in Progress` such as blogs and release notes that show active development

My draft slides are available at https://slides.com/mike-1/minimum-viable-documentation/#/
Speakers
avatar for Mike Jang

Mike Jang

Senior Staff Technical Writer, ForgeRock
As a senior technical writer for ForgeRock, Mike Jang spends much of his time documenting how deployers can modify JavaScript to customize web applications. He still has to help maintain over 200 curl commands in product documentation. He has also written a couple dozen technical... Read More →

slides minimum viable documentation (1) zip
Wednesday September 26, 2018 11:40am - 12:00pm CDT
Davidson Ballroom B 1/2
  Describing and Understanding APIs