FinTech API docs rebuilt to elevate developer experience

Challenge

‍

Pay.com is a financial technology company providing businesses with payment solutions such as virtual terminals, payment gateways, and point-of-sale (POS) systems. Pay.com additionally provides merchant account services, allowing businesses to accept and process credit card and electronic payments. To keep up with its expanding user base and service offerings, Pay.com required extensive and ongoing API documentation services that would appeal to its developers, engineers, and end users. 

‍

Solution

‍

Pay.com chose DevDocs for its ability to provide an expert technical writer with experience planning and creating user guides and articles that appealed to both technical/API developer audiences as well as end users. The selected writer possessed the necessary knowledge of APIs and best practices for the organization and presentation of API installation and configuration documentation. The technical writer’s extensive experience in explaining process flows allowed for an agile documentation plan for creating product use cases and strengthening Pay.com developer support.

‍

Results

‍

Upon reviewing and editing their existing documentation, DevDocs’ technical writer identified gaps and organizational opportunities, streamlining and expanding Pay.com developer documentation, and establishing a style guide, adding brand-specific terminology and style requirements so contributors to the developer portal would have access to clear and succinct guidelines. Flow charts and visual recommendations were drafted, as DevDocs’ writer worked closely with Pay.com SMEs to create documentation and tutorials for community forums and public roadmaps, alongside planning a continuous content strategy to encourage users to stay informed of product releases and feature updates. 

‍

DevDocs’ team created SEO-focused use cases to help users and prospective customers better understand the features and functionality of Pay.com’s offerings. With extensive API documentation services covering both its developers and end users, Pay.com was able to safeguard its continued growth with concise documentation that streamlines internal processes and provides clear direction to users.