CatalogueDelivery Documentation & QA
API Integration Guide
Writes an integration guide from the real endpoints, fields, and status codes in the backend.
What it examines
- The inbound endpoints a partner actually calls
- Request and response fields as the code defines them
- Status codes and error shapes
- The sequence from create, to documents, to submit
What you get back
An integration guide a partner's engineering team can build against.
Dependencies
- An AI coding agent that reads SKILL.md files, such as Claude Code, Codex or Gemini CLI
- The backend repository the integration runs on. The skill reads the real request and response classes and the process config.
- Google Chrome installed, to turn the HTML guide into a PDF
- The client’s name or ticket, and which endpoints are in scope. The skill asks for them.
- Optional: pdftoppm, to read pages of the PDF back and check them
How it works
It reads the backend code to find the endpoints a partner calls, with their request and response fields, status codes and permissions. It never invents a field or an endpoint. Anything it cannot confirm is marked as unconfirmed.
It fills a fixed HTML template, so every client’s guide looks the same, then renders it to PDF with headless Chrome and checks a few pages.
The guide is client-facing and never mentions the tools used to make it. You get a PDF a partner’s engineers can build against.
Setup
- Unzip the download. Copy the skill folder into your agent's skills folder (for Claude Code, .claude/skills/) in the backend repository, or into its global skills folder to use it in every project.
- Check that Google Chrome is installed. Restart your agent so it picks up the skill.
- Open the backend repository in your agent and ask it to run the generate-api-integration-guide skill.
- Answer its questions about the client and the endpoints. It saves the PDF in the client’s instructions folder.
Run it with your agent
Copy the prompt, fill in the parts in square brackets, and paste it into your agent.
Run the generate-api-integration-guide skill on this backend repository. Client or ticket: [name]. Endpoints in scope: [list]. Use only what the code confirms, and mark anything unconfirmed. Save the PDF in the client’s instructions folder.