The pages here are still under construction.
Objective
The goal was to evaluate how effectively RexPay’s original API documentation helped developers start quickly, and to redesign it with clearer steps, better structure, and modern documentation practices (e.g. using examples, interactive code playground, error handling, and progressive onboarding).My Role
- Technical Writer (solo project)
- Responsible for research, information architecture, markdown authoring, and front-end doc presentation.
Tools & Stack
- Markdown + MDX - for content formatting
- Mintlify - for documentation and deployment
- Git + VS Code - version control and workflow
Process
-
Analyzed the Original Docs
- Noted unclear entry point
- Observed confusing information across pages
-
Improved Structure
- The actual Quickstartpage is not task-oriented
- Created a Quickstart page guiding new developers faster
- Used consistent headings and spacing (following Stripe’s and OpenAI’s structure)
-
Polished The API Reference Pages
- The API Reference pages are not interactive
- Most of the reference pages do not touch on errors
- The HTTP verbs are often not specified
- Endpoints not properly arranged
- Code samples are provided in one language (Javascript) only
-
Published + Iterated
- Deployed on Mintlify
- Shared online for feedback from fellow technical writers and developers
Before vs After (Key Improvements)
| Feature | Original Docs | Rewritten Version |
|---|---|---|
| Quickstart flow | Reference-heavy | Task-oriented to guide new developers |
| Code examples | Limited | Multi-language with interactive display to test the code |
| Tone | Formal & vague | Action-oriented, developer-friendly |
| Error Handling Page | Not available | Provided a page dedicated to possible errors that developers may face |