Quality API Documentation Development

Download the PDF version of the case study.

Challenge

Payfone works with businesses to confirm their customers’ and Quality API Documentationemployees’ identities for safer mobile interactions. Security is their business and mobile devices are their primary platform.

Payfone’s primary software products utilize APIs to connect their customers to their software. Payfone required immediate support updating and maintaining their outdated API documentation as well as publishing timely software release notes. The API documentation and release notes were not easily accessible online. Payfone needed a solution to give their customers access to the content online.

The goal of this project was to quickly and effectively provide Payfone with accurate, professional API documentation to support its software products. InfoPros also assisted in making this content available to its customers in an online format.

Payfone was focused on new product development and much of the recent documentation was not up-to-date. Thus the top priority for InfoPros was to quickly edit and update the existing API guides to reflect the current software release of each API.

 

Solution

InfoPros started the project by talking with the Engineering group and decided upon a solution to migrate to a new tool that would support both HTML and PDFs. Working with the Engineering group, InfoPros started the process to identify the required changes to ensure each of the API guides accurately reflected the most recent release. All of the developed API Documentation was reviewed to ensure that it properly displays when published in both PDF and HTML formats.

Previously the API guides were published only as PDFs, which were difficult to search and update. To ensure the content could easily be found online, InfoPros moved the existing API documentation to the MadCap Flare authoring tool.

InfoPros developed MadCap Flare templates for the API documentation to provide quality online as well as PDF publishing, thus ensuring the documentation would meet Payfone’s branding and standards as well as improve access for their clients.

 

Result

InfoPros was able to quickly provide the updates to the API documentation bringing Payfone’s software documentation up-to-date.

The documentation provided by InfoPros was accurate, up-to-date, professional documentation which eliminated a major pain point for Payfone’s existing customers. Payfone was able to give its API documentation the level of professionalism they desired in addition to giving its clients the access to the tools they need so they can use the software more effectively.

Read more InfoPros case studies.