Aspire API Documentation

The inauguration of the Aspire API Guide sought to address service underutilization and adoption gaps. The API guide provided a solution by delivering conceptual information, code samples, examples, an interactive console, resource definitions, and a changelog singularly sourced under one platform.

  • The company needed to launch an API guide to increase user adoption and experience.

  • To increase user adoption, provide more comprehensive information and ensure that it is simple and convenient for users to access. 

  • After careful planning and collaboration, I constructed an API guide with a well-defined API reference, conceptual information, a changelog, and an interactive console.

  • The technical writing team syncs and updates the change log and reference material for every major and minor release. 
    ​
    Before publishing changes,  contributing product owners and managers provide feedback.

The Process

  • 01. Scope

    1. After identifying the main concerns and project needs, wants, and limitations, I identified a list of viable deliverables to complete by the next fiscal year.

    2. I leaned on my previous experience creating a dev portal to illustrate an ideal solution.

    3. After approval from informed contributors, I created a task list identifying objectives to complete across a timeline. I also rallied subject matter experts and stakeholders for the project.

  • 02. Manage

    1. Throughout the process, I scheduled weekly syncs with contributors from Product and Engineering to properly define endpoints and attributes.

    2. I met with the Product Lead, Owner, Manager, and departmental director biweekly to provide progress updates and timeline changes.

  • 03. Structure

    1. After scoping the project, I used Doc360 for the API ecosystem. I made this decision because it was a tool included in the company budget and equipped to build out a central resource for the API.

    2. Upon integrating Swagger, I discovered the ready-built API console was incompatible with the Aspire API definition because the reference did not specify servers.

    3. After Engineering resolved the issues, I designed a folder tree and built templates using an agreed-upon blueprint. I also drafted reference material and definitions for each resource and its endpoints and attributes.

  • 04. Review

    After drafting the reference and endpoint material, I set up an extensive review process involving internal and a small group of external stakeholders.

  • 05; Roll Out

    After the beta phase, I demoed the project at departmental and company-wide meetings.

Writing Samples