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.

Technical documentation: APIs, guides, README v1.0.0

Use this resource to write clear, structured and verified technical documentation

New

  • 448 downloads
  • 229 likes
  • 122 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install technical-documentation-writing-7

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 identifies the type of document needed, gathers context, structures the content and adds verified code examples. You get documentation ready to publish, with templates for READMEs, guides and release notes.

Mostly picked by

Updated November 2, 2026

Card for the “Technical documentation: APIs, guides, README” skill

Details

Generates with
Your agent's model
Licence
MIT

Similar resources

View all

What you get

  • references/documentation-types-and-workflows.md: document types and workflows
  • references/writing-guidelines.md: clear writing rules
  • SKILL.md: README and project documentation templates

Good fit for

  • Your project has no README or an incomplete API reference
  • You are preparing release notes for a major update

Not for

    Tags

    • documentation
    • api
    • readme
    • guide
    • release notes

    About

    You say

    “Write the README for my TypeScript library, with installation steps, an example and the list of options.”

    Card for the “Technical documentation: APIs, guides, README” skill

    Skill published by dauquangthanh 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 clear, structured and verified technical documentation
    3. Review and adjust the result

    Content preview

    Files

    • LICENSE1 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • references/documentation-types-and-workflows.md17.8 KB
    • references/writing-guidelines.md13.3 KB
    • SKILL.md5.7 KB

    Origin and licence

    Listed unmodified

    Author
    dauquangthanh
    Source
    github.com/dauquangthanh/hanoi-rainbow/tree/0e2ebaea024ad494bfd39cba73effa61a9c978cf/skills/technical-writing
    Licence
    MIT

    Notice

    « technical-writing » (dauquangthanh, 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.