docs-patterns

docs-patterns is a skill for Claude Code, Codex from Jartan-LLC/grimoire. It costs 18 tokens per session (1,332 once invoked), scanned A, original, MIT.

A set of conventions for writing technical documentation, including its tone, structure, length, and suitability for different document types.

In plain words
What is it for?
Use it when creating tutorials, how-to guides, reference material, or explanations that should match existing documentation.
Why use it?
It gives writers a consistent way to make instructions and explanations clear, brief, and appropriate for their purpose.

Skill for Claude CodeCodex

Part of the praxis plugin — 16 skills, 7 agents shipped together

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/jartan-llc/grimoire/docs-patterns
Any agent
npx skills add Jartan-LLC/grimoire --skill docs-patterns
Clone the repo
git clone --depth 1 https://github.com/Jartan-LLC/grimoire

Made for: Claude Code, Codex.

Or install praxis, the plugin that ships this one along with the rest of its 16 skills, 7 agents.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for docs-patterns

README.md
[![agentmods](https://agentmods.dev/badge/skills/jartan-llc/grimoire/docs-patterns.svg)](https://agentmods.dev/skills/jartan-llc/grimoire/docs-patterns)
Your own site
<a href="https://agentmods.dev/skills/jartan-llc/grimoire/docs-patterns"><img src="https://agentmods.dev/badge/skills/jartan-llc/grimoire/docs-patterns.svg" alt="Measured on agentmods" height="20"></a>
Per session 18 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,332 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00018 $0.01332
Opus 5 $0.00009 $0.00666
Sonnet 5 $0.00004 $0.00266
Haiku 4.5 $0.00002 $0.00133

Measured 3d ago against content hash 3e45143c963b, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

docs-patterns scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 3d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

plugins/praxis/skills/docs-patterns/SKILL.md · 96 lines

How it starts

The opening of the file, as written. The whole thing — 96 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Documentation Writing Patterns

Before writing, read 2-3 existing docs in the same category to match their tone and structure.

Writing Style

Tone: Technical but accessible. Imperative for instructions ("Use X..."), declarative for specifications ("The User model has these fields..."). No marketing language.

Brevity is paramount. A doc that could be 100 lines should not be 300. Every paragraph must earn its place. If a table communicates it better than prose, use a table. If a link to another doc covers it, don't restate it. Be precise, not exhaustive.

Doc Types

Pick the type before the shape -- the four Diataxis types each want a different shape. Two questions place any doc: action (doing) or cognition (understanding)? Study (learning) or work (the task at hand)?

Type Purpose Shape Which am I writing?
Tutorial Learning-oriented -- teach a newcomer by doing Guided, sequential lesson whose steps are guaranteed to work "Teaching a beginner start-to-finish; if they follow along they succeed."
How-to Task-oriented -- reach one real goal with existing skills Numbered steps for a single task; assumes competence "Helping a competent user accomplish one specific goal."
Reference Information-oriented -- authoritative facts consulted mid-task Austere, structured to mirror the code, consistent patterns and tables "Describing what is -- consulted, not read through."
Explanation Understanding-oriented -- the why, context, trade-offs Discursive prose; weighs alternatives and reasoning "Explaining why -- read away from the code to understand."

The Section Structure below is the reference shape. Don't force tutorials, how-tos, or explanations into it -- each has its own shape above.

Section Structure

The reference shape (see Doc Types). All reference- and README-style docs follow a consistent pattern:

  1. H1 title with a one-line description
  2. Overview -- brief intro, bullet list of capabilities/features
  3. Configuration -- tables for settings/env vars (Setting | Default | Description)
  4. Usage -- practical code examples showing realistic patterns
  5. Implementation details -- topic-specific sections as needed
  6. See Also -- related doc links

Read the full file on GitHub · 96 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 3d ago First seen · 96 lines · 18 tokens per session scan A 3e45143c963b

Subscribe to this mod's changes

docs-patterns is a skill published in the GitHub repository Jartan-LLC/grimoire (2 stars, last pushed 15d ago), licensed MIT. It adds 18 tokens to every session and 1,332 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other skills, from other repositories

goutoujunshi

恋爱军师与情绪支持 skill。用于心动、暧昧、追求、聊天记录或截图分析、约会、关系确认、多人选择、冲突、冷淡、投入失衡、分手、复合、出轨、婚姻或家庭问题;也用于分析关系信号、设计主动推进或退出策略、润色可直接发送的话术,以及把冷读、自然流、Blueprint、Mystery 等经典社交体系转译成真实、互惠、可退出的沟通能力。支持分析ChatLab已有数据和经同意可撤销的长期关系档案,不负责导出聊天软件数据。首次使用时为用户及一个或多个目标对象建立包含 MBTI、主观综合评分和关系背景的档案。.

shengjidaguai-china/goutoujunshi · 175 tokens

gpt-image

Use this skill whenever a user asks to generate, create, draw, render, or edit images with GPT Image 2 / gpt-image-2, text-to-image, reference-image editing, inpainting, posters, typography, Chinese text, UI mockups, diagrams, or gallery prompts. Analyze the user's prompt, search the bundled Reference Gallery/craft…

wuyoscar/GPT-Image2-Skill · 120 tokens

pixel2motion

Turn a raster logo (PNG/JPG/WebP/screenshot) into a clean minimal SVG with edge smoothness as the primary hard gate and IoU optimized as high as reasonably possible without a fixed global threshold, then into a choreographed logo animation delivered as standalone JS-rendered HTML, applying Disney's 12 animation…

nolangz/pixel2motion · 163 tokens

beautify-github-readme

Redesign GitHub README homepages or create project-native pure SVG, hybrid SVG-composed PNG/WebP, and opt-in animated GIF assets. Use when a user asks to beautify, redesign, rebrand, visually upgrade, simplify, or audit a GitHub README; create only a hero, section headers, diagrams, badges, motion graphics, showcase…

oil-oil/beautify-github-readme · 143 tokens

submit-product-directories-v2-quality

SPD V2 Quality. Discover, deeply qualify, submit, and audit truthful product listings across Windows, macOS, and Linux-capable environments on relevant product, software, startup, app, and AI-tool directories with audience-value screening, SEO quality gates, action-level authorization, privacy controls, and…

flaqai/backlink_skills · 125 tokens

codex-autoresearch

Run autonomous, measurable experiments in a Git repository: change one hypothesis, verify a numeric metric, keep improvements, and revert failures. Use when the user wants Codex to keep iterating toward a numeric target in the foreground or as a detached background run. Do not use for ordinary one-shot coding…

leo-lilinxiao/codex-autoresearch · 80 tokens