Agent skill

Docs Style

by heypoom in heypoom/patchies

Patchies documentation style guide. An agent skill from heypoom/patchies.

AGPL-3.0Auto-check passedWriting & Content

Install Docs Style

skills CLI
$ npx skills add heypoom/patchies --skill docs-style -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install heypoom/patchies docs-style --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/heypoom/patchies.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/docs-style .claude/skills/docs-style && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
docs-style
GitHub stars
209
Token cost
~1k tokens
SKILL.md length
365 words
Files
1
Skills in repo
8
Repo updated
First seen
Licence
AGPL-3.0

At a glance

Patchies documentation style guide. An agent skill from heypoom/patchies.

  • Works in 7 steps: H1 title — one sentence intro explaining… → Screenshot or image (if available) —… → ✨ Try-it link — > ✨ Try this patch —… → …
  • Writing & Content work in your project
  • SKILL.md covers Voice & Tone, Page Structure (Topic Docs), Formatting Rules and Content Principles, plus 1 more section
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Docs Style is an agent skill from heypoom/patchies. Patchies documentation style guide. Load when writing or editing topic docs in ui/static/content/topics/ or ui/static/content/objects/. Describes the voice, structure, and formatting conventions for all Patchies docs.

Its SKILL.md is about 1k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Writing & Content. It works with JavaScript. The repository describes itself as: Write small programs with tools & libraries you know and patch 'em together. Make interactive widgets, visuals, sounds, and play with computation on the web. The licence is AGPL-3.0.

When your agent uses it

  • Writing & Content work in your project

Example prompts

  • “Use the docs-style skill to patchy documentation style guide. An agent skill from heypoom/patchies”
  • “/docs-style”

Workflow steps

7 steps, taken from the first numbered list in SKILL.md.

  1. H1 title — one sentence intro explaining what this topic is and why it matters
  2. Screenshot or image (if available) — with a caption or context sentence below
  3. ✨ Try-it link — > ✨ Try this patch — brief description.
  4. How It Works — the mental model first, before any API or steps. Use analogies (e.g. "like a hardware signal chain")
  5. Try It — hands-on exercises. Use ### sub-headings per exercise.
  6. Feature sections — one ## section per major concept, separated by ---
  7. See Also — links with one-line descriptions

What it can do on your machine

Read from SKILL.md and the folder at commit dd38c74. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are markdown and javascript).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Docs Style loads about 1k tokens when it runs. Until then it costs about 57 tokens; SKILL.md has 365 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~57
When it runs · the whole SKILL.md, loaded when a task matches
~1k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from heypoom/patchies at commit dd38c74, republished under its AGPL-3.0 licence (© heypoom). 365 words, ~1,041 tokens.

Download SKILL.mdSave it as .claude/skills/docs-style/SKILL.md (or your agent's skills folder).
name
docs-style
description
Patchies documentation style guide. Load when writing or editing topic docs in ui/static/content/topics/ or ui/static/content/objects/. Describes the voice, structure, and formatting conventions for all Patchies docs.
paths
ui/static/content/**/*.md

Patchies Documentation Style Guide

Use this guide whenever writing or editing documentation in ui/static/content/.

Voice & Tone

  • Friendly but concise — welcoming like P5.js docs, not terse like a man page
  • Write for someone who knows how to code but is new to Patchies
  • Lead with the concept ("what it is and why you'd use it"), then the how
  • Use "you" to address the reader directly
  • Avoid filler phrases: "Note that", "It's worth mentioning", "Simply", "Just"

Page Structure (Topic Docs)

Follow this order — omit sections that don't apply:

  1. H1 title — one sentence intro explaining what this topic is and why it matters
  2. Screenshot or image (if available) — with a caption or context sentence below
  3. ✨ Try-it link — > ✨ [Try this patch](/?id=...) — brief description.
  4. How It Works — the mental model first, before any API or steps. Use analogies (e.g. "like a hardware signal chain")
  5. Try It — hands-on exercises. Use ### sub-headings per exercise.
  6. Feature sections — one ## section per major concept, separated by ---
  7. See Also — links with one-line descriptions

Formatting Rules

Headings
  • Use ## for major sections
  • Use ### for sub-sections and exercises
  • Never use bold text as a heading — always use a proper # heading
markdown
<!-- WRONG -->

**Exercise — Simple tone**

<!-- RIGHT -->

### Exercise — Simple tone
Callouts

Use blockquote callouts for tips, warnings, and try-it links:

markdown
> ✨ [Try this patch](/?id=abc123) — brief description.

> **Tip**: Use the `logger.js` preset to inspect messages.

> **Note**: Objects like `expr` use hot and cold inlets.

> **Important**: Always connect to `out~` to hear audio.
Show full SKILL.md (162 more words)Show less
Code Examples
  • Every API function must have a runnable example, not just a signature
  • Add inline comments explaining why, not just what
  • Show realistic values (use 440 not n, use 0.3 not value)
javascript
// WRONG — too abstract
setInterval(callback, ms)

// RIGHT — copy-pasteable and clear
setInterval(() => {
  send({type: 'bang'})
}, 500)
Tables

Always include a spaced separator row:

markdown
| Column A | Column B | Column C |
| -------- | -------- | -------- |
| value    | value    | value    |
Lists

Prefer numbered lists for sequential steps, bullets for unordered options. Keep bullets short — one line each when possible.

Code Diagrams

Use plain text for signal flow — it's clear and universal:

text
[osc~ 440] → [gain~ 0.5] → [out~]

Content Principles

Concept Before API

Always explain the mental model before listing functions:

markdown
<!-- WRONG — starts with API -->

Use `setPortCount(inletCount, outletCount)` to set inlets.

<!-- RIGHT — concept first -->

Each js object starts with one inlet and one outlet.
Use `setPortCount()` to add more when your logic needs them:
Avoid Duplication
  • If a concept is fully covered in another doc, link to it — don't repeat it
  • A brief one-example intro + "See [X] for the full API" is the right pattern
  • message-passing.md owns message concepts; javascript-runner.md owns the JS API
Exercises

Every topic doc should have at least one hands-on exercise. Format:

markdown
### Exercise — Descriptive name

1. Create a `foo` object (`Enter` → type `foo`)
2. Connect it to a `bar` object
3. Do something — you should see/hear the result
See Also

End every topic doc with a See Also section. Format:

markdown
## See Also

- [Page Title](/docs/slug) — one-line description of what it covers
- [Object Name](/docs/objects/name) — what the object does

File Locations

  • Topic docs: ui/static/content/topics/<slug>.md
  • Object docs: ui/static/content/objects/<name>.md
  • Register new topic docs in ui/src/routes/docs/docs-nav.ts

© heypoom, AGPL-3.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .agents/skills/docs-style of heypoom/patchies.

Open the folder on GitHubat commit dd38c74

Compare with similar skills

Docs Style next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Docs Style compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Docs Style this skillheypoom/patchies209—~1kAutomated safety check: PassAGPL-3.0
JavaScript Concept Fact Checkerleonardomso/33-js-concepts67k1 repos~5kAutomated safety check: PassMIT
Install Anti Sloptrycompai/crm11k1 repos~881Automated safety check: PassMIT
JavaScript Concept Page Workflowleonardomso/33-js-concepts67k—~3.9kAutomated safety check: PassMIT
JS Concept Resource Curatorleonardomso/33-js-concepts67k—~4.9kAutomated safety check: PassMIT
Translatetagspaces/tagspaces5.3k—~2.2kAutomated safety check: PassAGPL-3.0

Similar skills

  • JavaScript Concept Fact Checker

    leonardomso/33-js-concepts

    Verifies the technical accuracy of JavaScript concept pages by checking code examples, MDN and ECMAScript claims and external links through a five-phase method.

    67k GitHub starsUsed in 1 repo~5k tokens
    Writing & ContentAuto-check passed
  • Install Anti Slop

    trycompai/crm

    Install and configure the anti-slop Oxlint plugin in a local TypeScript or JavaScript repository.

    11k GitHub starsUsed in 1 repo~881 tokens
    Writing & ContentAuto-check passed
  • JavaScript Concept Page Workflow

    leonardomso/33-js-concepts

    Orchestrates five skills to produce a complete JavaScript concept documentation page, from resource curation through writing, tests, fact-checking and SEO.

    67k GitHub stars~3.9k tokensUpdated 26 days ago
    Writing & ContentAuto-check passed
  • JS Concept Resource Curator

    leonardomso/33-js-concepts

    Finds, vets, writes up and maintains external articles, videos and courses for JavaScript concept pages, including audits for broken and outdated links.

    67k GitHub stars~4.9k tokensUpdated 26 days ago
    Writing & ContentAuto-check passed
  • Translate

    tagspaces/tagspaces

    Translate new or untranslated i18n strings from the English locale files (core.json + peri.json) into all other locales, maintaining consistency with each language's existing translations.

    5.3k GitHub stars~2.2k tokensUpdated yesterday
    Writing & ContentAuto-check passed
  • JavaScript Concept Page Writer

    leonardomso/33-js-concepts

    Writes or reviews documentation pages for the 33 JavaScript Concepts project, following its structure, a beginner-friendly voice and rules against AI-sounding language.

    67k GitHub stars~14k tokensUpdated 26 days ago
    Writing & ContentAuto-check passed

More from heypoom/patchies

All 8 skills in this repo
  • Patchies Audio

    heypoom/patchies

    A skill your agent uses when adding, migrating, or changing Patchies Audio V2 nodes, native DSP worklet nodes, audio object docs, audio packs, or AudioService integration.

    209 GitHub stars~1.6k tokensUpdated today
    Auto-check passed
  • Patchies Frontend

    heypoom/patchies

    A skill your agent uses when editing Patchies Svelte components, UI state, styling, buttons, persistence, or frontend implementation patterns.

    209 GitHub stars~992 tokensUpdated today
    Auto-check passed
  • Patchies Objects

    heypoom/patchies

    A skill your agent uses when adding, editing, or migrating Patchies nodes, objects, handles, object modules, schemas, object docs, AI prompts, file drag/drop support, or node data settings.

    209 GitHub stars~2.2k tokensUpdated today
    Auto-check passed
  • Patchies Workflow

    heypoom/patchies

    A skill your agent uses when working in Patchies on tests, specs, reflections, verification scope, or commits, especially before changing product behavior or when the user explicitly asks to commit.

    209 GitHub stars~712 tokensUpdated today
    Auto-check passed
  • Patchies Assembly Module

    heypoom/patchies

    A skill your agent uses when changing Patchies assembly VM code, VASM Rust sources, wasm-pack output, machine WASM assets, asm object behavior, or modules/vasm build/link steps.

    209 GitHub stars~341 tokensUpdated today
    Auto-check passed
  • Patchies Rendering

    heypoom/patchies

    A skill your agent uses when changing Patchies rendering pipeline, render graph, image generation preview capture, GLSystem, render workers, FBO rendering, output sizing, render-node types, or video…

    209 GitHub stars~656 tokensUpdated today
    Auto-check passed

Works with

Questions about Docs Style

What does Docs Style do?

Patchies documentation style guide. An agent skill from heypoom/patchies. Docs Style is an agent skill from heypoom/patchies. Patchies documentation style guide.

When should I use Docs Style?

Docs Style fits situations like: writing & Content work in your project.

How do I install Docs Style in Claude Code?

Run `npx skills add heypoom/patchies --skill docs-style -a claude-code`. Or copy the skill folder (.agents/skills/docs-style in heypoom/patchies) into .claude/skills/docs-style in your project. Claude Code loads it when a task matches its description.

How do I install Docs Style in Codex?

Run `npx skills add heypoom/patchies --skill docs-style -a codex`. Or copy the skill folder (.agents/skills/docs-style in heypoom/patchies) into .agents/skills/docs-style in your project. Codex loads it when a task matches its description.

Can I use Docs Style in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add heypoom/patchies --skill docs-style -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/docs-style, .gemini/skills/docs-style, .github/skills/docs-style and .opencode/skills/docs-style in your project.

What does Docs Style need to run?

SKILL.md names no scripts, command-line tools or credentials: Docs Style is instructions for the agent only.

Does Docs Style access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Docs Style safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Docs Style use?

Docs Style is published under the AGPL-3.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Docs Style use?

About 1k tokens (SKILL.md is roughly 4.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Docs Style?

Skills that share tags, products or a category with Docs Style: JavaScript Concept Fact Checker (leonardomso/33-js-concepts, 67k stars), Install Anti Slop (trycompai/crm, 11k stars), JavaScript Concept Page Workflow (leonardomso/33-js-concepts, 67k stars) and JS Concept Resource Curator (leonardomso/33-js-concepts, 67k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Docs Style?

heypoom (a GitHub user) maintains it in heypoom/patchies, which has 209 GitHub stars. The repository holds 8 skills in this directory. The repository was last updated on October 7, 2026.

Source: heypoom/patchies on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.