1. Introduction to
Documentation
@getpostman
API Publishers Series: Part 1

2. Agenda
1 What is an API Publisher?
2 Introduction to Documentation
3 Types of API Documentation
5 Resources
4 Make your APIs discoverable
@getpostman
6 Q&A

3. A little about you
Respond to polls
● How long have you been using Postman?
● How much experience do you have with writing documentation in
Postman?
@getpostman

4. A little about you
Respond to polls
● How long have you been using Postman?
● How much experience do you have with writing documentation in
Postman?
● How much time does your team spend on API documentation?
@getpostman

5. @getpostman
What is an API Publisher?
Your API is available to other app developers for consumption

6. Learning Objectives
At the end of this session, you will be able to:
● Explain the influence of documentation on user onboarding
● Develop a checklist for good documentation
● Generate documentation from OpenAPI specification
● Build sample workflows/guides for easier onboarding
● Publish a public workspace for community collaboration
● Share documentation in the Postman API Network
@getpostman

7. Why document?

8. Demo

9. Learning objectives
@getpostman
recap
During this session, we learned how to:
● Explain the influence of documentation on user onboarding
● Develop a checklist for good documentation
● Generate documentation from OpenAPI specification
● Build sample workflows/guides for easier onboarding
● Publish a public workspace for community collaboration
● Share documentation in the Postman API Network

10. Fork the learning materials
www.postman.com/postman/workspace/postman-space-camp/
@getpostman
To your own workspace

11. Additional Resources
Good Documentation Checklist
blog.postman.com/postman-good-documentation-checklist/
30 Days of Postman for Developers
postman.com/postman/workspace/30-days-of-postman-for-developers/
Community Forum
community.postman.com
@getpostman

12. What’s Next?
A few things to look forward to:
● WYSIWIG Documentation
● Forking an API
● … and more
@getpostman
Postman product roadmap
go.pstmn.io/public-roadmap

13. Thank You
@getpostman