API Documentation

The Project

As part of the modernization efforts for our technical customer site, I modernized the display of our 13 existing APIs. The effort is also part of transforming the larger legacy experience into a mobile-first, WCAG AA accessible site.

Key Stakeholders

Along with internal business needs, the target audience is software engineers, with a secondary audience of business leaders. 

Requirements

The project requirements were driven by our discovery research and specific business needs. Our primary requirement was to refactor existing content into a more concise and informative experience. We are also providing visitors a direct connection to our API teams. One of the most important requirements is to meet WCAG AA compliance. As part of our discovery work we also uncovered the desire for a tablet viewable experience for developers and a mobile view for business leaders.

Collaborations

This cross functional team effort included close work with multiple project managers, the engineering team, marketing, the legal team, account executives, and senior leadership. Discovery research was a collaboration between the project manager and myself.

The Results

The solution resulted in a foundational set of templates that allowed minimal design intervention and rapid migration of the APIs.