Free Live Product Demonstrations and Webinars

MadCap Icon

API ABCs

Jul 8, 8:00-9:00 am (Pacific Time) Online Webinar

An Application Programming Interface (API) is a set of instructions for accessing a web-based application. APIs let applications work together to get, send, or update information. Because APIs have no interface, the API documentation becomes the face of the product. As a technical writer, your job is to clearly define the API's concept, functionality, connectivity and messaging requirements, and expected responses for the API. Your audience is a developer. Your tasks are many:

  • Decide how much business information to include for developers who may not be familiar with your industry
  • Mine information from a variety of sources: detailed designs, developer meetings, acceptance testing, schemas, Wikis, change requests, QA samples, interviews with developers
  • Structure the documentation so that the developer audience can quickly access functionality, message syntax, and samples
  • Understand how versioning impacts your developers
  • Use tools to help you read code and schemas

In this webinar, join Allison Ellington, Technical Product Manager, and Lori Guillory, Team Lead, Technical Communications, of Travelport, the leading travel commerce platform for the global travel and tourism industry, for an in-depth look covering everything you need to know about documenting APIs.


Presenters:

Allison Ellington, Technical Product Manager | Travelport
Lori Guillory, Team Lead, Technical Communications | Travelport


Getting Started with MadCap Flare, Part 1: Basic Concepts

Jul 23, 8:00-9:00 am (Pacific Time) Online Webinar
Presenter: Neil Perlin, Certified Flare Trainer and Consultant | Hyper/Word Services

Are you new to MadCap Flare? Do you need help getting started with the rich set of features and functionality that comes with Flare? Are you new to authoring concepts and terminology?

MadCap Software is excited to present a new four-part series from certified trainer and consultant Neil Perlin of Hyper/Word Services. By the end of this series, you’ll have strong understanding of the concepts critical for success and a strong understanding of the key features and functionality of MadCap Flare.

Topics covered in this first session include:

  • Authoring in Flare compared to authoring in Word – analogies.
  • What’s a project?
  • What’s a topic?
  • What’s topic-based authoring and how does it differ from document-based authoring?
  • What’s structured authoring?
  • What’s single sourcing (two definitions)?
  • What’s multi-channel publishing?
  • What’s version control?


Have a suggestion for a webinar topic? Send us your suggestion here >>