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.

Writing READMEs and technical documentation v1.0.0

Use this resource to write READMEs and technical documentation in Markdown

New

  • 328 downloads
  • 192 likes
  • 142 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install markdown-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 writes or restructures your project's README and documents using clear conventions. You get documentation a newcomer can follow, written in Markdown.

Mostly picked by

Updated November 2, 2026

Card for the “Writing READMEs and technical documentation” skill

Details

Works in
Install guides
Generates with
Your agent's model
Licence
Apache-2.0

Similar resources

View all

What you get

  • SKILL.md : structure of a minimal README and a comprehensive README
  • SKILL.md : installation, usage, license and badge sections

Good fit for

  • Your project has no README or an incomplete one
  • You want clear install instructions for newcomers

Not for

    Tags

    • readme
    • documentation
    • markdown
    • project

    About

    You say

    “Write the README for this project with installation steps, usage and an MIT license.”

    Card for the “Writing READMEs and technical documentation” skill

    Skill published by thebushidocollective 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 READMEs and technical documentation in Markdown
    3. Review and adjust the result

    Content preview

    Files

    • LICENSE3.8 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • SKILL.md6.6 KB

    Origin and licence

    Listed unmodified

    Author
    thebushidocollective
    Source
    github.com/thebushidocollective/han/tree/19caa51d5fd144ef6b2764f2332f4c856aa5d1af/plugins/validation/markdown/skills/markdown-documentation
    Licence
    Apache-2.0

    Notice

    « markdown-documentation » (thebushidocollective, 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.