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.

Write project documentation v1.0.0

Use this resource to generate or improve documentation for code, an API or a repository

New

  • 596 downloads
  • 123 likes
  • 214 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install code-documentation-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 walks the directory tree, reads key files and the public API surface, then writes documentation sized to the project. You get accurate documents, structured for new contributors.

Mostly picked by

Updated November 2, 2026

Card for the “Write 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: three-step codebase analysis method
  • SKILL.md: templates for README, API reference and developer guides

Good fit for

  • Your project has no README or an outdated one
  • You want an API reference built from existing code

Not for

    Tags

    • documentation
    • readme
    • api
    • developer

    About

    You say

    “Write the README for this repository with installation, usage and a reference of the public functions.”

    Card for the “Write project documentation” skill

    Skill published by bytedance 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 generate or improve documentation for code, an API or a repository
    3. Review and adjust the result

    Content preview

    Files

    • LICENSE1.1 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • SKILL.md13.6 KB

    Origin and licence

    Listed unmodified

    Author
    bytedance
    Source
    github.com/bytedance/deer-flow/tree/f42076a005e3ba7fa23e61012f2ac9098917af20/skills/public/code-documentation
    Licence
    MIT

    Notice

    « code-documentation » (bytedance, 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.