Course snapshot

• Objectives: The course will equip participants with the ability to:
  • • Discuss and document modern APIs with authority.
    • Have a robust process for documenting any REST API.
    • Understand how developers use APIs to build applications.
    • Be able to document API flows and write comprehensive user guides.
    • Be able to set up tools and environments for testing and documenting APIs
    • Learn Docs-as-Code tools and workflows
• Mode of delivery: Online, live sessions
• Dates: 6 Saturdays starting 28th September, 8 hours of offline exercises
• Time: 10 AM to 12 Noon
• Fees: INR 19850 per participant
• Certification: Based on attendance and performance
  

  Course content

  The course commences by establishing a solid understanding of APIs, progressing into a comprehensive exploration of OpenAPI. It then outlines a meticulous process for documenting APIs, encompassing the gathering of source material from development artifacts, strategic documentation planning, crafting API references, creating user-friendly “get started” guides, and detailing functionalities and implementation recipes.

  Prerequisites

  Before the course, the trainer will provide instructions for setting up the needed software and repositories.

  You need to download the following software:

• Docker Desktop
• Postman
• Postman agent

Visual Studio CodeYou need to clone the course GitHub repo and run the Docker containers.

You need a computer that can download software (i.e., some work computers do not allow this) and meets the requirements to run Docker desktop.

Evaluation

You need to 

• Submit the final documentation project created during the course and have it peer reviewed and incorporate any corrections
• Pass a test at the end that covers the different topics of the course
  

  Certification requirements

  You will receive a Certificate of Completion from STC India based on the following criteria

  • 80% attendance
  • 70% score on final exam
  • Submitted their final documentation project for review

Mark Wentowski is a seasoned global API documentation specialist with over 12 years of technical writing and content creation experience. Specializing in assisting companies in developing modern and user-friendly API documentation, he has worked across various domains, including air transport, healthcare, IoT, and FinTech, providing comprehensive knowledge base strategies for companies of all sizes.

His expertise spans a range of API types, including REST, GraphQL, and IoT. With a focus on delivering concise and engaging documentation, Mark has a proven track record of enhancing developer experiences and facilitating smoother onboarding processes.

Recent Experiences:

• At a Healthcare Startup, Mark led documentation for a Python API, including creating a comprehensive guide, developing a demo application, and integrating annotations for FastAPI documentation. The project is currently in progress on Upwork.
• For a FinTech Firm, Summa Financial Technology, he revamped API documentation, enhancing developer and business user consumption, rewriting training materials, creating Postman collections, and documenting their GraphQL API.

At an Air Transport multi-national, SITA, Mark documented IoT APIs, facilitating the use of mobile devices as data interfaces. He led the migration to Markdown and HTML, implemented ‘docs-as-code’ workflows, and developed a persona-driven information architecture approach for improved usability.

Mark also authored a free eBook on API documentation available at: https://docsgeek.io/api-docs-handbook.pdf

He has also appeared on some of the top technical writing podcasts discussing API documentation:

• Knowledge base ninjas
• Scott Abel’s “Coffee and content”

Registration 

Contact

For any questions, please write to us at  upskilling@stc-india.org