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

PalateKit

Menu

Request a resource

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

0 / 280

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 documentation developers actually read v1.0.0

Use this resource to write documentation that developers read

New

  • 577 downloads
  • 226 likes
  • 203 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install developer-documentation-writing

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 helps you write clear documentation: READMEs, API docs, tutorials and internal docs, structured so readers find what they need quickly. You get a documentation plan and drafts ready for review.

Mostly picked by

Updated November 2, 2026

Card for the “Writing documentation developers actually read” skill

Details

Generates with
Your agent's model
Licence
Apache-2.0

Similar resources

View all

What you get

  • SKILL.md: technical writing role
  • references/patterns.md: README and tutorial structures
  • references/sharp_edges.md: errors that make documentation useless

Good fit for

  • Your README does not let someone start the project in five minutes
  • Your API is used but its docs discourage developers

Not for

    Tags

    • documentation
    • readme
    • api
    • tutorial

    About

    You say

    “Rewrite my npm package's README: installation, a first example and a table of options.”

    Card for the “Writing documentation developers actually read” skill

    Skill published by omer-metin 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 documentation that developers read
    3. Review and adjust the result

    Content preview

    Files

    • LICENSE10.1 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • references/patterns.md7.1 KB
    • references/sharp_edges.md6.8 KB
    • references/validations.md2.2 KB
    • SKILL.md1.7 KB

    Origin and licence

    Listed unmodified

    Author
    omer-metin
    Source
    github.com/omer-metin/skills-for-antigravity/tree/e8dcf4e8737921a10088bd5c9eb65e81f74c051f/skills/documentation-that-slaps
    Licence
    Apache-2.0

    Notice

    « documentation-that-slaps » (omer-metin, 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.