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 clear project documentation v1.0.0

Use this resource to write or revise a README without copying the project's code

New

  • 329 downloads
  • 142 likes
  • 115 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install project-docs-glossary-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 keeps the why, the principles and what the code does not say, removes narrative and lists that go stale, deduplicates and links the root to sub-documents. You get short documentation that does not drift from the code.

Mostly picked by

Updated November 2, 2026

Card for the “Writing clear project documentation” skill

Details

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

Similar resources

View all

What you get

  • SKILL.md: keep and shed criteria
  • SKILL.md: edit pass and links to sub-documents

Good fit for

  • Your README copies the file and command lists
  • Two documents explain the same point

Not for

    Tags

    • documentation
    • readme
    • principles
    • writing

    About

    You say

    “Cut this README down to its principles and remove the file lists that go stale.”

    Card for the “Writing clear project documentation” skill

    Skill published by dzhng 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 or revise a README without copying the project's code
    3. Review and adjust the result

    Content preview

    Files

    • LICENSE1 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • SKILL.md3.7 KB

    Origin and licence

    Listed unmodified

    Author
    dzhng
    Source
    github.com/dzhng/jevgrep/tree/9971e04061e43f91f1d248353fd057288bfd24cf/.agents/skills/write-docs
    Licence
    MIT

    Notice

    « write-docs » (dzhng, 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.