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.
npx skills add PracticalSwan/agent-skills --skill documentation-patternsgit clone --depth 1 https://github.com/PracticalSwan/agent-skillsWrote 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.
[](https://agentmods.dev/skills/practicalswan/agent-skills/documentation-patterns)<a href="https://agentmods.dev/skills/practicalswan/agent-skills/documentation-patterns"><img src="https://agentmods.dev/badge/skills/practicalswan/agent-skills/documentation-patterns/github.svg" alt="Measured on agentmods" height="20"></a>Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.
<a href="https://agentmods.dev/skills/practicalswan/agent-skills/documentation-patterns"><img src="https://agentmods.dev/badge/skills/practicalswan/agent-skills/documentation-patterns.svg" alt="Reviewed on agentmods" width="80" height="20"></a>- NVIDIA SkillSpector warn
SkillSpector: 1 finding, up to high
These are SkillSpector’s own severities. On a checked sample its high-severity flags on skills were ~96% false positives — a documented command, a public API, a “never do X” rule — so we show them as a caution to read, not a verdict. Why →
- high Prompt Injection · line 81 Hidden instructions were detected in comments or invisible text. These could contain malicious directives. Manual review is recommended.Fix: Audit all comments and invisible characters. Remove any instructions that direct the agent to perform unauthorized actions. Use plain, reviewable content.
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.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5.1 | $0.00039 | $0.01148 |
| Opus 5.5 | $0.00016 | $0.00459 |
| Sonnet 5.5 | $0.00008 | $0.00230 |
| Haiku 4.5 | $0.00004 | $0.00115 |
Grade A, and why
documentation-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 1mo 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.
How it starts
The opening of the file, as written. The whole thing — 112 lines — stays where its author put it; the contents beside it link to each section on GitHub.
Documentation Patterns
Use this skill when the main problem is document shape and consistency rather than writing quality alone.
- Leverage native parallel subagent dispatch and 200k+ context windows where available.
Activation Conditions
Use symptom -> action triggers: when one matches, apply this skill and verify with the protocol below.
- Creating a new API, feature, or config guide
- Standardizing Markdown sections across repositories
- Writing migration or runbook documents
- Picking the right template for a doc request
Pattern Selection
- API docs: endpoints, auth, request and response schema, errors
- Feature docs: purpose, UX, dependencies, rollout, support
- Config docs: env vars, defaults, examples, failure modes
- Migration docs: changed behavior, upgrade path, verification
Cross-Skill Workflow
- Use documentation-authoring to gather context and draft the content before template selection becomes the bottleneck.
- Use this skill when structure, section order, or template choice is the main problem.
- Finish with documentation-quality to review the final document against quality expectations.
Agent Prompt Template
Use the documentation-patterns skill to choose and apply the best structure for a [document type].
Context: [feature, system, migration, or runbook].
Bias toward: [API docs, feature docs, config guide, migration guide, etc.].
Return the recommended section outline with short notes on why each section exists.
Shared Documentation Stack
Use this as the inherited baseline for documentation-authoring, documentation-quality, documentation-automation, and documentation-verification.
- Source of truth: identify owner, audience, canonical files, and freshness requirements before drafting.
- Structure: choose the smallest reusable pattern that fits the reader task.
- Verification: check links, commands, examples, screenshots, and version-sensitive claims before publishing.
- Handoff: state unresolved gaps, owners, and next review trigger instead of implying false completeness.
What ships with it
6 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.
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.
- 1mo ago Changed 98a6fc34431b
- 1mo ago Changed cd35f2bd1585
- 1mo ago Changed 9587f9fb2736
- 1mo ago First seen · 112 lines · 39 tokens per session scan A 13e5de47e4c5
documentation-patterns is a skill published in the GitHub repository PracticalSwan/agent-skills (21 stars, last pushed yesterday), licensed MIT. It adds 39 tokens to every session and 1,148 once invoked, about $0.0002 per session on Opus 5.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-30.
Other skills, from other repositories
librechat-docs
Use the official LibreChat documentation to install, configure, operate, and troubleshoot LibreChat.
test-patterns
Applies proven testing patterns — Arrange-Act-Assert (AAA), Given-When-Then, Test Data Builders, Object Mother, parameterized tests, fixtures, spies, and test doubles — to help write maintainable, reliable, and readable test suites. Use when the user asks about writing unit tests, integration tests, or end-to-end…
river-review-docs
A documentation review guide for checking whether project instructions and documentation match the code. It also compares Japanese and English documentation and checks that important terms are used consistently.
markdown-search
Search and navigate local markdown via MCP. Use when the user asks to search docs, find a README section, list headings/TOC, extract code examples by language, read frontmatter, or grep internal wikis and ADRs on disk.
doc-quality-review
Assess documentation quality across readability, consistency, audience fit, and prose clarity. Produces a scored review with actionable findings. This skill should be used before releases, during doc reviews, or when documentation feels unclear or inconsistent.
doc-claim-validator
Validate that claims in documentation match codebase reality. Extracts verifiable assertions (file paths, commands, function references, behavioral claims, dependencies) from markdown docs and checks them against the actual project. Use after code changes, before releases, or when docs feel untrustworthy.