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.

README, API and architecture documentation v1.0.0

Use this resource to document a project, its API or its architecture

New

  • 372 downloads
  • 168 likes
  • 240 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install readme-api-architecture-docs

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 produces a README covering installation, configuration, usage and licence, API documentation with request and response schemas, architecture docs and inline comments. It works from the existing code.

Mostly picked by

Updated November 2, 2026

Card for the “README, API and architecture documentation” skill

Details

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

Similar resources

View all

What you get

  • SKILL.md: README template (features, quick start, configuration)
  • SKILL.md: API documentation (schemas, authentication, error codes)
  • SKILL.md: architecture documentation and code comments

Good fit for

  • Your repository has no README a new contributor can use
  • Third parties use your API without up-to-date documentation

Not for

    Tags

    • documentation
    • readme
    • api
    • architecture

    About

    You say

    “Write the README for this repository with installation steps, environment variables and usage examples.”

    Card for the “README, API and architecture documentation” skill

    Skill published by travisjneuman 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 document a project, its API or its architecture
    3. Review and adjust the result

    Content preview

    Files

    • LICENSE1.1 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • SKILL.md1.8 KB

    Origin and licence

    Listed unmodified

    Author
    travisjneuman
    Source
    github.com/travisjneuman/.claude/tree/80adced2f6fc0cb54fadb0fd6f0d7429d1f84bd7/skills/agent-documentation-writer
    Licence
    MIT

    Notice

    « agent-documentation-writer » (travisjneuman, 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.