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 technical documentation and diagrams v1.0.0

Use this resource to write and maintain the technical documentation of a project

New

  • 328 downloads
  • 168 likes
  • 140 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install technical-documentation-diagrams-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 documentation alongside the code, generates Mermaid diagrams (flows, ERDs, sequences), audits documentation coverage and prepares team runbooks. You get versioned documentation aligned with the code.

Mostly picked by

Updated November 2, 2026

Card for the “Writing technical documentation and diagrams” skill

Details

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

Similar resources

View all

What you get

  • SKILL.md: overview, quick reference and common mistakes
  • references/writing-style.md: writing style guide
  • references/mermaid-diagrams.md: Mermaid diagrams
  • references/doc-coverage.md: documentation coverage audit

Good fit for

  • Your code changes faster than its documentation
  • You need to explain an architecture flow with a diagram

Not for

    Tags

    • documentation
    • mermaid
    • diagrams
    • markdown
    • runbook

    About

    You say

    “Document the authentication module and add a sequence diagram of the login flow.”

    Card for the “Writing technical documentation and diagrams” skill

    Skill published by oakoss 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 and maintain the technical documentation of a project
    3. Review and adjust the result

    Content preview

    Files

    • LICENSE1.3 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • references/ai-collaboration.md3 KB
    • references/doc-coverage.md9.3 KB
    • references/markdown-standards.md2.7 KB
    • references/mermaid-diagrams.md4.4 KB
    • references/runbooks-and-onboarding.md4.5 KB
    • references/writing-style.md5.3 KB
    • SKILL.md5.4 KB

    Origin and licence

    Listed unmodified

    Author
    oakoss
    Source
    github.com/oakoss/agent-skills/tree/85e3a3919d9e0ec7f7302a5143ec4b3e66f5f6ad/skills/technical-docs
    Licence
    MIT

    Notice

    « technical-docs » (oakoss, 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.