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.

Document code: README, API and guides v1.0.0

Use this resource to write documentation for a codebase, an API or a project

New

  • 427 downloads
  • 200 likes
  • 157 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install write-code-documentation-readme

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 follows a standard README template (installation, usage, API reference, configuration, contributing, license) and applies conventions for comments and guides. You get clear documentation, ready to publish in your repo.

Mostly picked by

Updated November 2, 2026

Card for the “Document code: README, API and guides” skill

Details

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

Similar resources

View all

What you get

  • SKILL.md : README template by section
  • SKILL.md : API reference and usage examples

Good fit for

  • Your project has no README or an outdated one
  • Your API must be documented for external developers

Not for

    Tags

    • documentation
    • readme
    • api
    • guides

    About

    You say

    “Write the README for my Node.js project, with installation and function reference.”

    Card for the “Document code: README, API and guides” skill

    Skill published by moizibnyousaf 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 documentation for a codebase, an API or a project
    3. Review and adjust the result

    Content preview

    Files

    • LICENSE1.1 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • SKILL.md5.9 KB

    Origin and licence

    Listed unmodified

    Author
    moizibnyousaf
    Source
    github.com/moizibnyousaf/ai-agent-skills/tree/6d95c788aa22ce39a4807b9a4c31c758a2036dc6/skills/code-documentation
    Licence
    MIT

    Notice

    « code-documentation » (moizibnyousaf, 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.