Breaking The Mold: Creating Task-Oriented API Documentation

Presented by

Mark Wentowski > Host: Scott Abel

About this talk

Technical and API Docs specialist Mark Wentowski explores the need to structure docs to reflect how developers use APIs to solve specific problems rather than relying on arbitrary labels such as 'concepts,' 'integrations,' 'samples,' 'recipes,' or 'API reference.' Wentowski will also explore innovative approaches to creating documentation more aligned with developers' needs and habits. Topics to be covered: Traditional vs. Task-Based API Docs: Examining standard content like API references and code samples and their limitations regarding ambiguity, navigation difficulties, and misalignment with user goals. Developer-Centricity: Tailoring docs to different developer types (systematic, opportunistic, pragmatic) and integrating concepts directly into task descriptions for better utility. Efficient Strategies: Implementing adequate redundancy, side-by-side content-code layouts, intuitive navigation, context-aware semantic search, and considering single-page docs to enhance user experience. Strategic Implications: Emphasizing the need for custom information architecture and exploring content strategies for developers and non-developer stakeholders. Can't make it? Register, and we'll send you a link to watch a recording when convenient. Mark Wentowski helps API developers around the globe explain their solutions to various audiences. He primarily works with SaaS companies delivering web-based, developer-to-developer conceptual docs for web services (i.e., APIs), libraries, and other software products, including deployment and configuration guidance for IT and DevOps engineers, user guidance for data scientists and engineers, API and command references, tutorials, walkthroughs, sample apps, and best practices guides. This webinar is brought to you by The Content Wrangler. The show sponsor is 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 (69)
On-demand talks (648)
Subscribers (72292)
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.