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.

Project documentation writing v1.0.0

Use this resource to write a project's README, guides and runbooks

New

  • 510 downloads
  • 122 likes
  • 105 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install project-docs-writer

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 updates human-facing documentation: README, guides in docs/, operating procedures. It leaves code comments and requirements alone. You get clear pages that follow the skill's style guide.

Mostly picked by

Updated November 2, 2026

Card for the “Project documentation writing” 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: scope, workflow and prohibitions
  • references/style-guide.md: documentation style guide

Good fit for

  • Your README does not let a new contributor install the project
  • You need to document a deployment procedure

Not for

    Tags

    • documentation
    • readme
    • guides
    • runbook

    About

    You say

    “Write the local setup guide for the project, for a new developer.”

    Card for the “Project documentation writing” skill

    Skill published by nextstage-brasil 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 a project's README, guides and runbooks
    3. Review and adjust the result

    Content preview

    Files

    • evals/evals.json0.7 KB
    • LICENSE11.1 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • references/style-guide.md1.3 KB
    • SKILL.md2.8 KB

    Origin and licence

    Listed unmodified

    Author
    nextstage-brasil
    Source
    github.com/nextstage-brasil/skills/tree/397947265cb478166f5a110dc869afd1f8f3c04c/skills/ns-docs-writer
    Licence
    Apache-2.0

    Notice

    « ns-docs-writer » (nextstage-brasil, 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.