Every premium and members-only resource for $9.99/month, as a no-commitment subscription. See the plans

PalateKit

Sign in
Menu

Request a resource

Describe the resource you are missing in one sentence. We will email you when it is published.

0 / 280

A page, a video or an image online.

Unlock PalateKit

Unlock everything

Plan

Paying means accepting our terms of sale.

Secure payment by Stripe. Receipts and invoices sent by email.

Welcome back

Sign in to install, download or save this resource. A free account is enough for free resources.

API documentation writing v1.0.0

Use this resource to write clear API documentation for developers

New

  • 488 downloads
  • 128 likes
  • 193 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install api-reference-documentation

With no option, the skill goes to ~/.agents/skills/; add --agent claude-code (or codex, cursor…) to target an agent.

First time: connect the CLI with

npx --yes palatekit@latest login

The agent collects the API type, authentication method and base URL, then writes the documentation: endpoints, request and response examples, error codes and rate limits. It can also produce an OpenAPI or Swagger specification. You get a developer reference ready to publish.

Mostly picked by

Updated November 2, 2026

Card for the “API documentation writing” skill

Details

Works in
Install guides
Generates with
Your agent's model
Licence
MIT

Similar resources

View all

What you get

  • references/documentation-structure.md: sections to cover, from authentication to webhooks
  • references/output-template.md: Markdown template with worked examples
  • references/best-practices.md: best practices and quality checklist

Good fit for

  • Your API is used by customers working from out-of-date docs
  • You are publishing the first public version of your API

Not for

    Tags

    • api
    • documentation
    • openapi
    • developers

    About

    You say

    “Document our invoice REST API: key-based authentication, endpoints and error codes.”

    Card for the “API documentation writing” skill

    Skill published by onewave-ai under the MIT license, delivered in its original version.

    Show more

    How to use it

    1. Install the skill in your agent's skills folder
    2. Ask your agent to write clear API documentation for developers
    3. Review and adjust the result

    Content preview

    Files

    • LICENSE1.1 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • references/best-practices.md1.3 KB
    • references/documentation-structure.md1.4 KB
    • references/output-template.md3.3 KB
    • SKILL.md2.2 KB

    Origin and licence

    Listed unmodified

    Author
    onewave-ai
    Source
    github.com/onewave-ai/claude-skills/tree/b2267d9171af4f56848d82992381b20b89b44056/api-documentation-writer
    Licence
    MIT

    Notice

    « api-documentation-writer » (onewave-ai, MIT) livré dans sa version d'origine : fiche en français et en anglais par PalateKit.

    User reviews

    –

    No ratings yet

    Loading reviews…

    Delete your review?

    Your rating and comment will be removed from the page.