Every premium and members-only resource for $9.99/month, as a no-commitment subscription. See the plans

PalateKit

Menu

Request a resource

Describe the resource you are missing in one sentence. We will email you when it is published.

0 / 280

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.

Documentation style guide v1.0.0

Use this resource to write or review product documentation

New

  • 390 downloads
  • 179 likes
  • 184 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install technical-docs-style-guide

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 first picks the document type (tutorial, how-to guide, reference, explanation), then applies rules for voice, headings, structure and terminology. You get documentation that is shorter, consistent and useful to both readers and LLMs.

Updated November 2, 2026

"Good" and "avoid" examples of documentation sentences, and a 2x2 Diataxis map.

Details

Generates with
Your agent's model
Licence
Apache-2.0

Similar resources

View all
  • Free

    Video

    App window with zoom

    • 365365 downloads
    • 125125 likes
    • 188188 saves
    Works with
    • Claude Code
    • Codex
    • Cursor
    • and 3 more
    + HyperFrames
  • Free

    Video

    One big number

    • 463463 downloads
    • 223223 likes
    • 100100 saves
    Works with
    • Claude Code
    • Codex
    • Cursor
    • and 3 more
    + HyperFrames
  • PRO

    Video

    Three bars head to head

    • 348348 downloads
    • 133133 likes
    • 182182 saves
    Works with
    • Claude Code
    • Codex
    • Cursor
    • and 3 more
    + HyperFrames
  • PRO

    Video

    Before / after slider

    • 322322 downloads
    • 248248 likes
    • 238238 saves
    Works with
    • Claude Code
    • Codex
    • Cursor
    • and 3 more
    + HyperFrames
  • PRO

    Video

    Three-card carousel

    • 418418 downloads
    • 157157 likes
    • 101101 saves
    Works with
    • Claude Code
    • Codex
    • Cursor
    • and 3 more
    + HyperFrames
  • PRO

    Video

    Chat exchange

    • 564564 downloads
    • 127127 likes
    • 161161 saves
    Works with
    • Claude Code
    • Codex
    • Cursor
    • and 3 more
    + HyperFrames
  • PRO

    Video

    Checklist ticking off

    • 442442 downloads
    • 233233 likes
    • 160160 saves
    Works with
    • Claude Code
    • Codex
    • Cursor
    • and 3 more
    + HyperFrames

What you get

  • SKILL.md with voice, structure, consistency, pitfalls and a checklist
  • references/diataxis-compass.md: the Diataxis compass and map, with the quality model

Good fit for

  • You are writing a product's documentation or help centre
  • You want to review help pages to make them clearer
  • You need to standardise a team's terminology

Not for

  • Writing marketing copy or blog posts
  • Generating code documentation automatically from source

Tags

  • documentation
  • style
  • diataxis
  • writing
  • help

About

You say

"Review these help pages with the style guide and tell me which Diataxis type each one is."

"Good" and "avoid" examples of documentation sentences, and a 2x2 Diataxis map.

Skill published by existential-birds under the Apache-2.0 license.

Show more

Prerequisites

You bring
The documentation pages to write or review and Your product glossary, if you have one

How to use it

  1. Put the skill in your agent's skills folder
  2. Give it the pages to write or review
  3. Go through the checklist with the agent before publishing

Content preview

Files

  • LICENSE10.7 KB
  • NOTICE-PALATEKIT.md0.4 KB
  • references/diataxis-compass.md6.1 KB
  • SKILL.md10.5 KB

Origin and licence

Modified by PalateKit

Author
existential-birds
Source
github.com/existential-birds/beagle/tree/d1a74899fbfec74974d1818e4cac7c3d54d44b65/plugins/beagle-docs/skills/docs-style
Licence
Apache-2.0

Notice

Version modifiée de « docs-style » (existential-birds, Apache-2.0) : traduction française et fiche par PalateKit.

User reviews

–

No ratings yet

Loading reviews…

Delete your review?

Your rating and comment will be removed from the page.

Frequently asked questions

The skill mentions neighbouring skills (tutorial-docs, howto-docs…). Are they required?

No. They are optional pointers; the guide and the compass work on their own.

Are all the examples technical?

Yes, they come from API documentation, but the rules (active voice, clear headings, one term per concept) apply to any help text.