Integrating API Reference Data With Product Documentation

Logo
Presented by

Mel Davis and Vanessa Menzies-Flint

About this talk

Join Mel Davis and Vanessa Menzies-Flint, Reltio Technical Content team, in their journey to surface developer docs directly in the product documentation portal. They’ll demystify the complexities of synching developer-written OpenAPI source files to writer-managed ditamap files for final presentation in the product documentation portal. They’ll address additional dimensions for tech writers to influence the usability of API source documentation. Attendees will learn: * the benefits of making API source files available within product docs * the mechanics of integrating OpenAPI source files into a CCMS for presentation in a documentation portal (using Heretto) * strategies for collaborating with developers to improve the quality of API source files If you’re considering integrating an existing standalone developer portal into your product documentation portal–or are starting from scratch–this presentation will give you clear and actionable guidance. Melanie Davis is a passionate professional communicator specializing in technical data transformation and content curation. She is a long-term industry veteran with 30+ years in technical writing, editing, localization, and training with individual clients, startup companies, and global enterprises across the US and the UK. Vanessa Menzies-Flint is a writer, empathetic user-advocate, and problem-solver who specializes in developer documentation. Over the past two decades she has helped companies like the NFL, Salesforce, and Oracle communicate with their developer audiences. At Reltio, she is building a new developer experience, showcasing Reltio's REST APIs. Can’t make it? Register, and we’ll send you a link you can use to watch a recording when it’s convenient for you. This event is brought to you by The Content Wrangler and is sponsored by Heretto, a powerful component content management system (CCMS) platform to deploy help and API documentation in a single portal designed to delight your customers.
Related topics:

More from this channel

Upcoming talks (54)
On-demand talks (676)
Subscribers (73830)
The Content Wrangler Channel covers the people, methods, tools and technologies designed to help you deliver the right information, to the right people, at the right time, on the right device, in the right format and language. Your content is your most valuable business asset. Let us show you how to manage it efficiently and effectively.