11 Aug TWT API Doc Fair (Sept 2 and 9) (Online Event)
Welcome
Tech Writer’s Tribe invites you to a unique ONLINE API Documentation Fair.
The fair is completely dedicated to those who are API documentation writers or who want to know about API Documentation.
The fair will have multiple knowledge-sharing sessions and a Panel discussion in which leaders of the API Documentation team will participate.
Join the event to celebrate API Documentation and develop the key skillset required for a tech writer.
RECORDING of Both Days
If you were unable to register, you can still get access to recordings of both days.
- Make a payment of INR 400 to TWT UPI ID: paytechwriters@icici.
- Write to Support@techwriterstribe.com with a screenshot of the payment.
About the API Documentation Fair
Any event involves a lot of hard work. TWT is glad to have city volunteers who give their best efforts to make an event successful and care to think about all facilities of the participants and speakers.
TWT Team Chennai is hosting this event with contributions from TWT Team Gujarat, Pune, Hyderabad and NCR. For any questions, feel free to connect with them.
Organising Committee
- TWT Team Chennai (Host): Sudharshan, Deepa Siddharthan, Jude Almeida, Illangovan K, Harish Raj
- Collaborators: Shrutika Kalgutkar and Saurabh Toraskar (TWT Mumbai), Vishakha Rao and Shivani Waikar (TWT Pune), Suparna Nandani (TWT Gujarat), Anirban Dutta (Hyderabad)
Have a question?
Write to TWT Team: support@techwriterstribe.com
Call/WhatsApp/Telegram: +91 7337332587
The event is an opportunity for all to gain knowledge about API documentation at one place.
This event welcomes individuals who fit into the following categories:
- Technical writers who need guidance from experts or want to connect with others in this field.
- Managers who want to enhance their team’s performance in API Documentation delivery.
- Individuals who enjoy keeping up with trends in technical writing.
- Companies who want to understand how to effectively use API documentation to enhance their product.
- Freshers/Professionals from other fields who are considering technical writing as a career and would like to meet with professionals in this field.
Event Month: September 2023
Dates and Time:
- Sept 2: 10 AM-1 PM IST
- Sept 9: 5.45 PM-8.45 PM IST
Apart from attending the 7 presentations and Panel discussions, you also get other benefits.
Other Information
- Recording of the event will be shared with those who register.
- Additional reference resources related to API Documentation will be shared with those who join the sessions.
Registration:
Free for: TWT Volunteers/Presenters/Annual Members
Fee for Others
For India
- INR 400 from TWT website using UPI payment
- INR 375 from Tech Writer’s Tribe App
Outside India
USD 25 using Paypal
The Schedule
The Experts and their Sessions
The Presenter: Prathap Rane K
Current Role: Engineer R&D, Kone Elevators Technology & Innovation Centre
The Topic
Introduction to API Documentation (Hardware and Internal)
About the Session
The session will help you understand the basics of API.
Key Highlights
- What is API?
- Why API is essential for developers, users, and the success of the API
- Explanation of different types of APIs Detailed exploration of the significance of API documentation
- Detailed exploration of the significance of API documentation Essential elements of effective API documentation
About the Presenter
Prathap Rane is working as an R&D Engineer with Kone Elevators Technology & Innovation Centre in Chennai.
For the last 2 years, he is handling API at his workplace. He has integrated, tested, and deployed for various requirements. Earlier, he worked as Android Developer.
The Presenter: Gaurav Trivedi
Current Role: Sr, Technical Writer, Red Hat (NCR)
The Topic
Understanding API Languages
About the Session
Complete information on:
- JSON
- Basics of JSON
- JSON Syntax
- JSON Data Types
- XML
- Basics of XML
- XML Syntax
- XML vs JSON
About the Presenter
(In his own words..) I’m an avid writer who loves to read, converse, and connect. Currently working at Red Hat, I’m loving my career in this interesting and versatile profile.
I’ve always been a person who thrives to learn, gain experience, and sincere at whatever I do. I’ve been using Antora for over five years. I’m currently using it daily to document many projects at Red Hat, my current organization.
The Presenter: Pravin Kumar
Current Role: Sr. Information Developer at Rockwell Automation
The Topic
API documentation using Swagger
About the Session
The presentation will cover the following:
- UI of Postman
- UI of Swagger
- JSON format
- Knowledge of Endpoints
- How to send a query in Postman and understand the response.
- Document an endpoint in Swagger
About the Presenter
My API journey started when I learned the syntax for JSON. I worked with SMEs around the globe to acquire knowledge on this subject. I have exposure in the plan and the design phase of a new API project.
I’m a nature enthusiast. I learn about nature by involving myself in various sports activities like Surfing, Canyoneering, and Trekking. I have also volunteered through NGOs for beach clean-ups and helped kids on treks to experience nature.
The Experts and their Sessions
The Presenter: Pallavi Deshpande
Current Role: Principal User Assistance Developer, Oracle
The Topic
API Documentation Websites
About the Session
This session will cover all the essential aspects of a typical API doc website.
Key takeaways
- Who is the audience of API doc website?
- What are the must-have and good-to-have topics on the API doc website
- How to plan for the API Doc website?
- Look at some of the best API documentation websites
About the Presenter
Pallavi Deshpande is an accomplished Technical Writer with overall 15+ years of experience. Having helped organisations shape their Developer documentation strategy, she holds specialisation in production documentation also. Apart from product and API documentation, she loves to play around Docs-as-code using Hugo.
The Presenter: Robert Delwood
Current Role: Consigliere Deputy API Documentation Principal Writer, iManage
The Topic
Automating API Documentation
About the Session
An increasing number of tools assist in automating API documentation. This presentation reviews different techniques and approaches to creating API documentation, from near-complete automation and best practices to manual processes.
About the Presenter
I am a programmer, writer, and programmer-writer in Chicago’s legal community but formerly with NASA’s Johnson Space Center in Houston. I’m passionate about technical writing, dedicated to API documentation, and obsessive about making the complex into the simple.
With more than 18 years of experience, I’ve written Microsoft documentation for device drivers and speech recognition APIs/SDKs, and help desk/application manuals for the military.
The Experts and their Sessions
The Presenter: Chetan Bhatia
Current Role: Staff Technical Writer at BILL
The Topic
OpenAPI in code
About the Session
Learn about OpenAPI.
Key takeaways
- Advantages of working with OpenAPI
- Docs-as-code workflows with OpenAPI
- Toolsets for getting started
- Demos of workflows and toolsets
About the Presenter
For 10+ years, I have built and maintained API documentation and developer education for enterprise platforms and API services at scale.
In my current role as Staff Technical Writer at BILL, I own the documentation.
View website
The Presenter: Gayathri Krishnaswamy
Current Role: Senior Content Developer, OutSystems
The Topic
Unwrapping OpenAPI – From specification to engaging API Reference docs
About the Session
Learn about the template.
Key takeaways
- Understand how the OpenAPI specification empowers you to create comprehensive API reference documentation.
- Gain insights into how specific fields within the OpenAPI specification contribute to improving the user experience.
- Receive guidance on mapping the specification to various aspects of API reference documentation such as endpoints, requests/response examples, authentication, and error handling.
About the Presenter
I am an avid learner and a seasoned technical writer passionate about creating documentation that can help my readers solve real-world problems.
In my new role at OutSystems, I aspire to build the best API enablement experience for the developers. In my spare time, I enjoy reading good books and particularly enjoy historical fiction and biographies.
Panel Discussion
Ghaus Rabbani, with 15+ years of experience in Technical Content and related areas in product and services environments, has managed teams working with Agile software development teams.
Facilitated the creation of API documentation frameworks for enterprise products and open-source enterprise products.
Rohini Muralidharan works as Content Design Manager at Autodesk.
In her own words..
My interest lies in exploring new documentation methods, processes, tools, and technologies to help users and to enhance their experience in their product usage journey.
Currently, I am invested in learning and exploring API documentation and ways we can attain delightful API experiences.
I like to adopt open-source tools and technologies coupled with the docs-as-code methodology for their flexibility, interoperability, and cost-effectiveness.
Robert Delwood Practitioner for 15 years
In his own words..
I am a programmer, writer, and programmer-writer in Chicago’s legal community but formerly with NASA’s Johnson Space Center in Houston.
I’m passionate about technical writing, dedicated to API documentation, and obsessive about making the complex into the simple.
With more than 18 years of experience, I’ve written Microsoft documentation for device drivers and speech recognition APIs/SDKs, and help desk/application manuals for the military.
Pema Sherpa, working at LinkedIn, has been leading and creating API Documentation for many companies for the last 7 years.
In her own words..
With over 11 years of experience in technical writing, I specialize in creating product and developer documentation that translates complex technical concepts into clear and concise content.
I have a proven track record of delivering documentation projects that enhance customer satisfaction, business impact, and executive visibility.
Rakshanda jadhav
Posted at 11:46h, 12 AugustAPI documentation
Gopalkrishna Tharoor
Posted at 18:02h, 15 AugustRegistration done for the API fair Sep 2 n 9
NAVEEN BONGALE
Posted at 16:19h, 19 AugustWebinar is very helpful for beginners in APIs
Sunita Kumari
Posted at 20:29h, 19 AugustRegistration done for API Fair Sept. 2
Keren Chrysolite Jakkula Suresh
Posted at 19:55h, 24 AugustHow can I attend the sessions, let me know
K_admin
Posted at 13:30h, 26 AugustYou can click the registration link to register.
Ravi Chandran
Posted at 10:59h, 25 AugustRegistration done for Septmber 2 and 9. Excited to learn API documentation in-depth from experts.
Rakshanda jadhav
Posted at 20:10h, 27 AugustHow much time does it take to learn API documentation
K_admin
Posted at 10:18h, 31 August12-15 hours if you take up TWT API Documentation Certification course.