documentation-and-adrs

documentation-and-adrs is a skill for Claude Code, Codex from vanja-emichi/a0_agent_skills. It costs 45 tokens per session (2,623 once invoked), scanned A, original, MIT.

A guide for writing technical explanations and Architecture Decision Records, which document important choices and their reasons.

In plain words
What is it for?
Use it for READMEs, API documentation, onboarding material, inline explanations, and records of major technical decisions.
Why use it?
It makes systems, setup instructions, APIs, and design decisions easier for other developers to understand and use.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Needs its repository: it runs a file that does not travel with it, so clone the repository first. The line is - **Database**: Prisma + PostgreSQL — see [ADR-001](./docs/adrs/001-database.md).

Good fit Use it for READMEs, API documentation, onboarding material, inline explanations, and records of major technical decisions.

Compare 6 skills from other repositories ↓
Install

Getting it into your agent

It runs from inside its repository, so the clone comes first — what it calls does not travel with the file alone.

Clone the repo
git clone --depth 1 https://github.com/vanja-emichi/a0_agent_skills
agentmods
npx agentmods add skills/vanja-emichi/a0_agent_skills/documentation-and-adrs

Made for: Claude Code, Codex.

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-and-adrs

README.md
[![agentmods](https://agentmods.dev/badge/skills/vanja-emichi/a0_agent_skills/documentation-and-adrs/github.svg)](https://agentmods.dev/skills/vanja-emichi/a0_agent_skills/documentation-and-adrs)
Your own site
<a href="https://agentmods.dev/skills/vanja-emichi/a0_agent_skills/documentation-and-adrs"><img src="https://agentmods.dev/badge/skills/vanja-emichi/a0_agent_skills/documentation-and-adrs/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-and-adrs

Your own site · 80×15
<a href="https://agentmods.dev/skills/vanja-emichi/a0_agent_skills/documentation-and-adrs"><img src="https://agentmods.dev/badge/skills/vanja-emichi/a0_agent_skills/documentation-and-adrs.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 2,623 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.00045 $0.02623
Opus 5 $0.00023 $0.01311
Sonnet 5 $0.00009 $0.00525
Haiku 4.5 $0.00005 $0.00262

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

Security

Grade A, and why

documentation-and-adrs 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 11d 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.

skills/documentation-and-adrs/SKILL.md · 377 lines

How it starts

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

Documentation and ADRs

Overview

Write documentation that serves the reader, not the author. Good documentation answers the question the reader has at the moment they have it — not the question you wanted to answer. This skill covers README files, API documentation, Architecture Decision Records (ADRs), and inline documentation.

When to Use

  • Creating or updating a project README
  • Documenting an API (endpoints, request/response shapes)
  • Recording a significant architectural or technical decision
  • Explaining a non-obvious implementation choice
  • Setting up a new developer's onboarding experience

Documentation Types

1. README

The README is the front door of your project. It answers three questions:

  1. What is this? — One sentence description
  2. How do I start? — Working setup instructions
  3. How do I use it? — Common commands and patterns
# Project Name

One sentence: what this is and who it's for.

## Quick Start

\`\`\`bash
npm install
npm run dev
# → App running at http://localhost:3000
\`\`\`

## Development

\`\`\`bash
npm test          # Run tests
npm run build     # Production build
npm run lint      # Check code style
npm run type-check  # TypeScript validation
\`\`\`

## Environment Variables

| Variable | Required | Description |
|----------|----------|-------------|
| `DATABASE_URL` | Yes | PostgreSQL connection string |
| `SESSION_SECRET` | Yes | Random secret for session encryption |
| `STRIPE_API_KEY` | No | Stripe key (payment features only) |

Copy `.env.example` to `.env` and fill in the values.

## Project Structure

\`\`\`
src/
  api/        # API route handlers
  components/ # React components
  lib/        # Shared utilities
  types/      # TypeScript type definitions
\`\`\`

## Key Decisions

- **Database**: Prisma + PostgreSQL — see [ADR-001](./docs/adrs/001-database.md)
- **Authentication**: JWT sessions — see [ADR-002](./docs/adrs/002-auth.md)
- **Testing**: Vitest + Testing Library — see [ADR-003](./docs/adrs/003-testing.md)

## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md).

Read the full file on GitHub · 377 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. 11d ago First seen · 377 lines · 45 tokens per session scan A ea863087a1f2

Subscribe to this mod's changes

documentation-and-adrs is a skill published in the GitHub repository vanja-emichi/a0_agent_skills (5 stars, last pushed 1mo ago), licensed MIT. It adds 45 tokens to every session and 2,623 once invoked, about $0.0002 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

documentation-patterns

Technical documentation patterns for READMEs, ADRs, API docs (OpenAPI 3.1), changelogs, and writing style guides. Use when creating project documentation, writing architecture decisions, documenting APIs, or maintaining changelogs.

yonatangross/orchestkit · 53 tokens

document-writer

Write or update technical documentation grounded in the real codebase. Use when the user asks for README, API docs, architecture guides, user guides, CONTRIBUTING docs, migration notes, or JSDoc/code comments, or wants technical docs rewritten into natural Chinese with correct terminology. Not for general prose…

bahayonghang/my-ai-cli-toolkit · 75 tokens

documentation

Technical writing, API docs, and documentation best practices.

miles990/claude-software-skills · 12 tokens

technical-documentation

AI-powered technical documentation creation, maintenance, and auditing across README, ADR, API docs, runbooks, onboarding guides, changelogs, knowledge bases, and AI agent context files (AGENTS.md/CLAUDE.md). Primary keywords: technical documentation writing automation, ADR architecture decision record, API docs…

JPeetz/agent-skills · 115 tokens

write-readme

Generates or updates a README.md for a project or package. Reads the source code to understand the project and produces a clear, accurate README following the project's conventions. Invoked when the user asks to write, update, or generate a README.

soulcodex/agentic · 53 tokens

adr-documentation

Architecture Decision Records (ADR) documentation practice. Use when documenting architectural decisions, recording technical trade-offs, creating decision logs, or establishing architectural patterns. Trigger keywords - "ADR", "architecture decision", "decision record", "trade-offs", "architectural decision"…

MadAppGang/claude-code · 60 tokens