docs

A set of rules and guidance for maintaining project documentation, such as README files, contribution guides, changelogs, licenses, security policies, and architecture decision records. An architecture decision record is a short record of an important design choice.

In plain words
What is it for?
Use it when creating or reviewing a README, changelog, API documentation, contributor guide, or architecture decision record.
Why use it?
It helps teams know which project documents to create and what those documents should contain. This reduces missing or inconsistent documentation.

Skill for Claude CodeCodex

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/zircote-plugins/sdlc-quality/docs
Any agent
npx skills add zircote-plugins/sdlc-quality --skill docs
Clone the repo
git clone --depth 1 https://github.com/zircote-plugins/sdlc-quality

Made for: Claude Code, Codex.

Per session 63 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,436 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.00063 $0.01436
Opus 5 $0.00032 $0.00718
Sonnet 5 $0.00013 $0.00287
Haiku 4.5 $0.00006 $0.00144

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

Security

Grade A, and why

docs 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 2d 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.

.github/skills/docs/SKILL.md · 237 lines

How it starts

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

Documentation Standards

Guidance for implementing documentation requirements including project docs, changelogs, and Architecture Decision Records.

Tooling

Available Tools: If using Claude Code, the documentation-review plugin provides comprehensive documentation tools (/doc-review, /doc-create, /doc-update, /changelog). For ADRs, use the adr plugin (/adr:new, /adr:list, /adr:search).

Required Documentation

Mandatory Files (MUST)

Document Purpose
README.md Project overview, quick start, installation
CONTRIBUTING.md Contributor guidelines, setup instructions
CHANGELOG.md Version history and change documentation
LICENSE Software license terms
SECURITY.md Security policy and vulnerability reporting

Recommended Files (SHOULD)

Document Purpose
CODE_OF_CONDUCT.md Community standards
docs/architecture.md System design and decisions
API documentation Generated from code comments

README Requirements

Required Sections (MUST)

README MUST include:

  • Project name and brief description
  • Badge indicators (CI status, version, coverage, license)
  • Installation instructions (multiple methods if applicable)
  • Quick start/usage examples
  • Links to detailed documentation
  • License information
  • Contribution link

Recommended Sections (SHOULD)

README SHOULD include:

  • Feature list with descriptions
  • Architecture overview (diagram recommended)
  • Performance characteristics
  • Configuration options
  • Troubleshooting section

Badge Examples

[![CI](https://github.com/org/repo/actions/workflows/ci.yml/badge.svg)](...)
[![crates.io](https://img.shields.io/crates/v/package.svg)](...)
[![Coverage](https://codecov.io/gh/org/repo/branch/main/graph/badge.svg)](...)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](...)

Read the full file on GitHub · 237 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. 2d ago First seen · 237 lines · 63 tokens per session scan A bc48e51f4bc7

Subscribe to this mod's changes

docs is a skill published in the GitHub repository zircote-plugins/sdlc-quality (10 stars, last pushed 29d ago), licensed MIT. It adds 63 tokens to every session and 1,436 once invoked, about $0.0003 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.