Selected case studies

Case 11 / 12

EZOM Mateship Logistics Pty Ltd · Documentation

API Documentation & User Manuals

API documentation and end-user guides for customers and new teammates.

What it shows
Documentation
When
1/2024 - Current
Company
EZOM Mateship Logistics Pty Ltd
GitBookGraphQLAPI DocumentationEnglish

01 · The problem

Customers and new teammates had to ask the dev team how the GraphQL API and product flows worked.

02 · What I did

  1. 01Wrote API documentation and end-user guides in GitBook.
  2. 02Used the same docs for customer support and internal onboarding.
  3. 03Wrote the Wallets & Billing guides: top-up, auto-recharge, monthly fee, invoices, and payment methods.

03 · Screens

EZOM GitBook docs
EZOM GitBook docs

04 · What I achieved

What changed

  • Public docs at ezom.gitbook.io, used by customers and the team.
More about my time at EZOM

Next case study · EZOM

Security Hardening

API Documentation & User Manuals · case study | Bui Thuy Ngoc