documentation-conventions

documentation-conventions is a skill for Claude Code from joao-aires/agent-skills-public. It costs 46 tokens per session (1,284 once invoked), scanned A, original, MIT.

A documentation guide for organizing and updating product, architecture, schema, decision, plan, operations, and verification documents when software or decisions change.

In plain words
What is it for?
Use it during planning, feature work, migrations, deployment changes, and documentation reviews to update the affected records and indexes.
Why use it?
It keeps written project knowledge aligned with the implementation instead of leaving outdated instructions and decisions behind.

Skill for Claude Code

Written for Claude Code: user-invocable in frontmatter. Also seen: mentions AGENTS.md.

Good fit Use it during planning, feature work, migrations, deployment changes, and documentation reviews to update the affected records and indexes.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/joao-aires/agent-skills-public/documentation-conventions
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 joao-aires/agent-skills-public --skill documentation-conventions
Clone the repo
git clone --depth 1 https://github.com/joao-aires/agent-skills-public

Made for: Claude Code.

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-conventions

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

Your own site · 80×15
<a href="https://agentmods.dev/skills/joao-aires/agent-skills-public/documentation-conventions"><img src="https://agentmods.dev/badge/skills/joao-aires/agent-skills-public/documentation-conventions.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 46 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,284 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.
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.00046 $0.01284
Opus 5.5 $0.00018 $0.00514
Sonnet 5.5 $0.00009 $0.00257
Haiku 4.5 $0.00005 $0.00128

Measured yesterday against content hash 749f45c498db, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

documentation-conventions 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 yesterday.

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/documentation/skills/documentation-conventions/SKILL.md · 97 lines

How it starts

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

Read composition guidance for skill selection and invocation boundaries.

Keep documentation useful

For architecture baselines or substantive architecture/interface changes, read architecture-documentation for views, runtime/lifecycle boundaries, API analysis and source-backed verification.

When writing or revising prose, read and apply documentation-writing for reader purpose, explanations, examples, precision and presentation. This skill owns document responsibilities and maintenance; the writing skill guides authoring and reader review.

Use documentation/ with a short index and these areas as needed:

Area Useful content
product/ PRD: problem, users, outcomes, scope, acceptance criteria and success measures; roadmap
architecture/ Overview, C4 context/containers, data model, schemas and contracts
decisions/ Short ADRs and a decision log linking consequential choices
plans/ Identified work packages, progress, risks and open questions
ux/ Shared design principles, tokens and interaction patterns
operations/ Setup, deployment, runbooks, recovery and critical-journey observability/SLIs/SLOs
verification/ Important user journeys, testing approach and known limitations

Choose what to record

Preserve existing documentation conventions. Start with documents that answer real questions, not an empty folder checklist. Use C4 context/containers for system boundaries; add component detail only when useful. Use arc42 as an optional architecture outline and MADR for lightweight ADRs.

  • Keep a PRD focused on problem, users, outcomes, scope and acceptance criteria; keep the roadmap about priorities rather than duplicating implementation tasks.
  • Record an ADR for a consequential choice with alternatives and tradeoffs.
  • Keep routine reversible choices in the current plan or change description.
  • Link the decision log to ADRs; supersede historical decisions rather than rewriting history.

Read the full file on GitHub · 97 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. yesterday Changed · +22 lines 749f45c498db
  2. 2d ago Changed 57c11dced6f4
  3. 5d ago Changed · +15 lines 894bd6faf77d
  4. 7d ago First seen · 60 lines · 46 tokens per session scan A a872b36ccf95

Subscribe to this mod's changes

documentation-conventions is a skill published in the GitHub repository joao-aires/agent-skills-public (2 stars, last pushed yesterday), licensed MIT. It adds 46 tokens to every session and 1,284 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-10-15.

Related

Other skills, from other repositories