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.

README, API documentation and code comment templates v1.0.0

Use this resource to write the README and documentation of a project

New

  • 556 downloads
  • 180 likes
  • 103 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install documentation-templates-readme-api

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 orders README sections by priority, applies an API documentation template per endpoint and writes useful code comments. You get clear documentation for both people and agents.

Mostly picked by

Updated November 2, 2026

Card for the “README, API documentation and code comment templates” skill

Details

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

Similar resources

View all

What you get

  • SKILL.md: README section order and a full template
  • SKILL.md: API documentation structure and a per-endpoint template
  • SKILL.md: rules for code comments and AI-friendly documentation

Good fit for

  • Your project has no README, or one that doesn't make people want to try it
  • You must document an API for external developers

Not for

    Tags

    • readme
    • documentation
    • api
    • comments

    About

    You say

    “Write the README for my CLI, with installation, quick start and configuration.”

    Card for the “README, API documentation and code comment templates” skill

    Skill published by davila7 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 the README and documentation of a project
    3. Review and adjust the result

    Content preview

    Files

    • LICENSE1.1 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • SKILL.md3.4 KB

    Origin and licence

    Listed unmodified

    Author
    davila7
    Source
    github.com/davila7/claude-code-templates/tree/f57964ebda91cdfb31755661ecea9395f30020f1/cli-tool/components/skills/document-processing/documentation-templates
    Licence
    MIT

    Notice

    « documentation-templates » (davila7, 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.