documentation-guidelines

documentation-guidelines is a skill for Claude Code, Codex from thienanblog/awesome-ai-agent-skills. It costs 45 tokens per session (704 once invoked), scanned A, original, Apache-2.0.

A set of guidelines for designing and maintaining useful technical documentation. It focuses on ownership, intent, invariants, permissions, side effects, contracts, workflows, and operational limits.

In plain words
What is it for?
It helps create or audit module, feature, workflow, contract, and runbook documentation, while choosing the right owner and structure for each topic.
Why use it?
It keeps important context that is not obvious from source code in a durable, organized place and helps prevent duplicate or outdated documents.

Skill for Claude CodeCodex

Written for Claude Code and Codex: shipped in a Claude Code plugin, but also agents/openai.yaml present. Also seen: mentions subagents.

Part of the project-development-skills plugin — 11 skills shipped together

Good fit It helps create or audit module, feature, workflow, contract, and runbook documentation, while choosing the right owner and structure for each topic.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/thienanblog/awesome-ai-agent-skills/documentation-guidelines
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.

Any agent
npx skills add thienanblog/awesome-ai-agent-skills --skill documentation-guidelines
Clone the repo
git clone --depth 1 https://github.com/thienanblog/awesome-ai-agent-skills

Made for: Claude Code, Codex.

Or install project-development-skills, the plugin that ships this one along with the rest of its 11 skills.

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 documentation-guidelines

README.md
[![agentmods](https://agentmods.dev/badge/skills/thienanblog/awesome-ai-agent-skills/documentation-guidelines/github.svg)](https://agentmods.dev/skills/thienanblog/awesome-ai-agent-skills/documentation-guidelines)
Your own site
<a href="https://agentmods.dev/skills/thienanblog/awesome-ai-agent-skills/documentation-guidelines"><img src="https://agentmods.dev/badge/skills/thienanblog/awesome-ai-agent-skills/documentation-guidelines/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.

agentmods 80×15 button for documentation-guidelines

Your own site · 80×15
<a href="https://agentmods.dev/skills/thienanblog/awesome-ai-agent-skills/documentation-guidelines"><img src="https://agentmods.dev/badge/skills/thienanblog/awesome-ai-agent-skills/documentation-guidelines.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 45 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 704 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe. Third-party audits
  • NVIDIA SkillSpector pass 7 Sept 2026
How audits are shown
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.1 $0.00045 $0.00704
Opus 5.5 $0.00018 $0.00282
Sonnet 5.5 $0.00009 $0.00141
Haiku 4.5 $0.00005 $0.00070

Measured 27d ago against content hash c8fec18b9d30, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

documentation-guidelines 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 27d 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/project-development-skills/skills/documentation-guidelines/SKILL.md · 48 lines

How it starts

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

Documentation Guidelines

Capture durable meaning that code alone does not explain: business intent, ownership, invariants, permissions, contracts, and operational decisions. Let source and tests own implementation details and executable evidence.

Delegation

Run in the main conversation by default. Delegation can increase usage: obtain explicit approval for the proposed agent count and scope before using subagents. Reuse that approval within its bounds; ask again before expanding the approved count or scope.

Find the owner and evidence

Read the relevant documentation index and owner when present, then verify affected facts against source, tests, schemas, configuration, and runtime evidence. Follow links needed to understand the changed contract; stop when further reading no longer affects the result. Missing or stale documentation is a reason to inspect source, not a prerequisite that blocks work.

For the scope at hand, identify applicable actors, triggers, rules, state transitions, inputs/outputs, side effects, failure paths, ownership, and compatibility requirements. Omit irrelevant categories; record unresolved material facts without inventing them.

Change docs when durable meaning changes

Change Documentation action
Internal refactor, formatting, or fix restoring documented behavior Update only affected paths or evidence anchors, if any
User behavior, business rule, or workflow Update its existing owner
API, schema, permissions, events, or compatibility Update the contract and affected consumer mappings
Setup, migration, deployment, backup, or recovery Update the owning runbook
Entity renamed, moved, or removed Repair discovery routes and stale references
Duplicate or contradictory docs Preserve valid facts in one owner, repair links, then remove stale copies within scope

Avoid docs changes that merely record task activity. Keep transient plans, command logs, and CI output in the task, PR, or an existing evidence surface unless they represent a durable operating requirement.

Read the full file on GitHub · 48 lines

Files

What ships with it

4 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.

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. 27d ago Changed · -2 lines c8fec18b9d30
  2. 1mo ago Changed · -82 lines · -26 tokens per session 07fae199f6d2
  3. 1mo ago First seen · 132 lines · 71 tokens per session scan A 7066739aee1f

Subscribe to this mod's changes

documentation-guidelines is a skill published in the GitHub repository thienanblog/awesome-ai-agent-skills (70 stars, last pushed 27d ago), licensed Apache-2.0. It adds 45 tokens to every session and 704 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.

Related

Other skills, from other repositories

local-ai-agents

Build local-first AI agents that run entirely on a developer workstation with Microsoft Foundry Local and Qwen function-calling models. Covers Small Language Models (SLMs), the OpenAI-compatible local endpoint, sandboxed local tools, local RAG with Chroma, local MCP servers, hybrid cloud/local routing, and the…

microsoft/ai-agents-for-beginners · 200 tokens

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

next-cache-components-adoption

Turn on Cache Components in a Next.js app and resolve the blocking routes it surfaces. Use when the user wants to enable, adopt, or migrate to Cache Components, flip the cacheComponents flag, work through a flood of blocking-prerender / instant validation errors, run the cache-components-instant-false codemod, or…

vercel/next.js · 95 tokens

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens

insight-error-page

Write or audit an insight-kind error page for the Next.js dev overlay. Use when creating a new errors/ .mdx page, auditing an existing one, or checking that a page matches the framework fix cards. Covers page structure, title alignment, FixCard cards with Copy prompt button, code snippets, terminology verification…

vercel/next.js · 83 tokens