Open Source Documentation and Getting Started Guide for APIs

Lubaina Rangwala, Product Marketing Manager at ThoughtWorks will share the journey of creating an Open Source documentation.

• What were the goals with the documentation
• How did they want to measure the goals
• How they created the new guide (thought process)
• Their experience in validating the guide
• Some of their learning's from the research so far

Pema Sherpa, API and SDK Documentation Specialist at Bloomreach will talk about setting the ground for your APIs with a Getting Started guide.

• How to document REST APIs if you have quite a large API endpoints.
• Why tools that auto-generate API documentation do not help the developers from getting lost in the maze, without a comprehensive Getting Started piece.
• How to ramp up your developers on using the APIs, how the APIs work and what they absolutely must know.
• What are the elements of a Getting Started guide for API documentation and how these result in making docs holistic, detailed and self-sufficient.

Agenda:
9.30 am to 10.00 am : Registration
10.00 am to 10.45 am : "Documentation of an Open Source Product"
10.45 am to 11.00 am: Q and A
11.00 am to 11.15 am : Break
11.15 am to 12.00 pm: "Building the backbone of API docs through a Getting Started guide"
12.00 pm to 12.30 pm: Networking

Notes:

• The meetup will be at Data Labs room on the ground floor of B1 building (next to Sathya Bar)
• RSVP as No if you are not attending, this helps us organize the facilities better
• Contact Rajakavitha Kodhandapani 9845821669.