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.

Technical documentation templates: README, API, code v1.0.0

Use this resource to write a README, API documentation or code comments

New

  • 553 downloads
  • 231 likes
  • 146 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install technical-documentation-templates

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 relies on templates to structure a README by priority, document each endpoint, write JSDoc or TSDoc comments and keep a changelog. You get complete documentation without unnecessary sections.

Mostly picked by

Updated November 2, 2026

Card for the “Technical documentation templates: README, API, code” skill

Details

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

Similar resources

View all

What you get

  • sub-skills/readme-template.md: README template
  • sub-skills/per-endpoint-template.md: per-endpoint documentation template
  • sub-skills/jsdoctsdoc-template.md: JSDoc and TSDoc comment template

Good fit for

  • Your repository has no README a newcomer can use
  • Your public API has no per-endpoint description

Not for

    Tags

    • documentation
    • readme
    • api
    • jsdoc

    About

    You say

    “Write this repository's README with the essential sections, in priority order.”

    Card for the “Technical documentation templates: README, API, code” skill

    Skill published by dokhacgiakhoa 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 a README, API documentation or code comments
    3. Review and adjust the result

    Content preview

    Files

    • LICENSE2.4 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • SKILL.md1 KB
    • sub-skills/added.md0 KB
    • sub-skills/changed.md0 KB
    • sub-skills/essential-sections-priority-order.md0.3 KB
    • sub-skills/fixed.md0.3 KB
    • sub-skills/jsdoctsdoc-template.md0.3 KB
    • sub-skills/llmstxt-template.md0.3 KB
    • sub-skills/mcp-ready-documentation.md0.5 KB
    • sub-skills/per-endpoint-template.md0.3 KB
    • sub-skills/readme-template.md0.4 KB
    • sub-skills/when-to-comment.md0.3 KB

    Origin and licence

    Listed unmodified

    Author
    dokhacgiakhoa
    Source
    github.com/dokhacgiakhoa/agent-skills-4-vibe-coding-cli/tree/c4a059bbf7a8d6b2162071f0fbfe74053faa6d20/.agent/skills/documentation-templates
    Licence
    MIT

    Notice

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