Export or edit this event...

Write the Docs Portland December Meetup: Minimum Viable Documentation for RESTful APIs

Jama Software
135 SW Taylor St, Suite 200
Portland, OR 97204, us (map)

Please arrive by 6:15 as the doors lock after that time.

Website

Description

Our December meetup features a presentation by Mike Jang (Senior Staff Technical Writer at ForgeRock), as well as several very important announcements for the community. You don't want to miss this!

Here's a teaser for Mike's presentation, "Minimum Viable Documentation for RESTful APIs":

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.

Share

Tags