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.

Writing API reference documentation v1.0.0

Use this resource to write precise reference pages for an API or its symbols

New

  • 391 downloads
  • 171 likes
  • 113 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install api-reference-docs-2

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 applies a reference page template: name, parameters in a table, returns, example and related links. It follows writing principles that describe without explaining and let the structure mirror the product. You get pages that are easy to scan for experienced readers.

Mostly picked by

Updated November 2, 2026

Card for the “Writing API reference documentation” skill

Details

Works in
Install guides
Generates with
Your agent's model
Licence
Apache-2.0

Similar resources

View all

What you get

  • SKILL.md: reference page template (name, parameters, returns, example)
  • SKILL.md: writing principles, precise descriptions and brevity

Good fit for

  • You document the functions or endpoints of a public API
  • Your developers look for precise parameters

Not for

    Tags

    • reference
    • api
    • parameters
    • documentation

    About

    You say

    “Write the reference page for the createInvoice function: parameters, returns and an example.”

    Card for the “Writing API reference documentation” skill

    Skill published by existential-birds under the Apache-2.0 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 precise reference pages for an API or its symbols
    3. Review and adjust the result

    Content preview

    Files

    • LICENSE10.7 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • SKILL.md11.4 KB

    Origin and licence

    Listed unmodified

    Author
    existential-birds
    Source
    github.com/existential-birds/beagle/tree/d1a74899fbfec74974d1818e4cac7c3d54d44b65/plugins/beagle-docs/skills/reference-docs
    Licence
    Apache-2.0

    Notice

    « reference-docs » (existential-birds, Apache-2.0) 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.