ποΈ Business Document Template
A Business Use Case document describes a real-world business process or scenario β what it does, why it matters, and what outcomes to expect. It should help business, product, support, and engineering teams understand how a feature works from a user's perspective.
ποΈ API Integration Document Template
This template standardizes API integration documentation for both consumers and engineers. Each section targets a specific integration need β from setup through error recovery.
ποΈ API Error Code Document Guidelines
This guide provides comprehensive instructions for documenting API error codes in the Convenient Checkout project. Error documentation consists of two parts: MDX pages (user-facing documentation) and JSON data files (structured error data consumed by React components).
ποΈ UI Integration Document Template
This template standardizes UI integration documentation for frontend engineers, platform engineers, and QE/automation engineers. Think of a UI integration doc as "How do I integrate, operate, and test your UI safely?" β not product marketing.
ποΈ UI Error Document Guide
This guide documents how validation and error message tables are structured and rendered using JSON data imports in this project.
ποΈ OpenAPI Spec Authoring Standards
Audience: Tech Leads, Backend Engineers, API Designers, QA Engineers
ποΈ HLD Template
| Field | Detail |