Postman Intergalactic Logo. Illustration.

API Publishers Series, Part 1: Introduction to Documentation

Aired: Wednesday, October 6, 8:00 a.m. (PDT)

Postman Intergalactic Logo. Illustration.

Join us for a one-hour, introductory Postman learning session geared specifically for API publishers. We'll walk you through popular Postman features like workspaces and Postman's API documentation tool while we discuss how to craft a strong developer experience.

Here's what we'll do in this session:

  • Explain how documentation influences user onboarding
  • Develop a checklist for good documentation
  • Generate documentation from an OpenAPI specification
  • Create API reference and workflow guides for easier onboarding
  • Publish a public workspace for community collaboration
  • Share documentation in the Postman API Network and via the Run in Postman button icon button

Prerequisites:

  • Create a Postman account, and then sign in.
  • Download and install the Postman desktop agent, which will enable you to use the web version of Postman that we use in Postman Intergalactic sessions.

Speakers

Meenakshi Dhanani, Developer Advocate Postman

Meenakshi Dhanani

Developer Advocate

Postman

Arlémi Turpault, Senior Developer Advocate Postman

Arlémi Turpault

Senior Developer Advocate

Postman


Postmanaut riding a bike delivering a letter. Illustration.

New sessions release each month

Sign up to get notified about upcoming Postman Intergalactic sessions.

Notify me →

2024 State of the API report is here!

Discover key API trends from 5,600+ devs and API professionals in Postman's annual report.