documentation

documentation is a skill for Claude Code, Codex from paruff/uFawkesAI. It costs 72 tokens per session (2,105 once invoked), scanned A, original, MIT.

A documentation standard and audit checklist for repositories. A repository is a project's code and related files stored together, and a README is its introductory guide.

In plain words
What is it for?
Use it when auditing a repository before release, adding a repository to a shared suite, or checking README sections such as scope, status, setup, and links.
Why use it?
It reduces onboarding friction and makes project information easier for developers and coding agents to find and use.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one. Also seen: mentions Claude Code; installed under .agents/ (shared by several agents); mentions AGENTS.md.

Good fit Use it when auditing a repository before release, adding a repository to a shared suite, or checking README sections such as scope, status, setup, and links.

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

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

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

Your own site · 80×15
<a href="https://agentmods.dev/skills/paruff/ufawkesai/documentation"><img src="https://agentmods.dev/badge/skills/paruff/ufawkesai/documentation.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 72 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,105 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.00072 $0.02105
Opus 5.5 $0.00029 $0.00842
Sonnet 5.5 $0.00014 $0.00421
Haiku 4.5 $0.00007 $0.00211

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

Security

Grade A, and why

documentation 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 24d 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.

.agents/skills/documentation/SKILL.md · 188 lines

How it starts

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

Skill: Documentation

Load trigger: "load documentation skill" > DORA: AI Capability 3: AI-accessible internal data + 2023 DORA finding: documentation quality Token cost: Low

Purpose

Apply a consistent, minimum documentation standard across all 8 uFawkes* repos. Ensures that documentation is good enough to be AI-accessible (capability 3), good enough to reduce onboarding friction for Dojo learners (capability 6), and good enough to build platform trust for users evaluating fawkes (capability 7).

DORA 2023 State of DevOps: Quality documentation amplifies the positive impact of all technical capabilities. This is not a vanity metric — it is a force multiplier.

Minimum README Standard

Every uFawkes* repo README must contain these sections. Use this as a checklist. Sections marked ✅ are required for release. Sections marked ⚠ are required within 30 days of first release.

Section Required Content
What This Is ✅ 2-3 sentences. What problem does this repo solve? Who is it for?
What This Is Not ✅ 1-2 sentences. Explicit scope boundary prevents misuse.
Status ✅ Current version, what works today, what's next. Update every release.
Quick Start ✅ Commands to go from clone to running in <5 min. Must actually work.
Architecture ⚠ Link to ARCHITECTURE.md or a brief component diagram.
Testing ✅ How to run tests. Expected output. What the tests cover.
DORA Capability ⚠ Which DORA capability this repo addresses and how.
Contributing ✅ Link to CONTRIBUTING.md. CONTRIBUTING.md must not be a placeholder.
Suite Context ✅ Where this fits in the uFawkes portfolio. Links to fawkes and ufawkes.dev.
License ✅ License type and link.

Read the full file on GitHub · 188 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. 24d ago Changed 9596e54bb568
  2. 1mo ago First seen · 188 lines · 72 tokens per session scan A 94bd0e2264c7

Subscribe to this mod's changes

documentation is a skill published in the GitHub repository paruff/uFawkesAI (2 stars, last pushed yesterday), licensed MIT. It adds 72 tokens to every session and 2,105 once invoked, about $0.0003 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-31.

Related

Other skills, from other repositories

proxmox-full

Complete Proxmox VE hypervisor management via REST API - VMs, containers, snapshots, backups, storage.

marcusquinn/aidevops · 27 tokens

pave-env

Set up local development environments — devcontainers, Docker Compose, one-command setup, dev/prod parity. Use when asked to "set up dev environment", "devcontainer", "docker compose for dev", "local development setup", or "one command to run".

tonone-ai/tonone · 57 tokens

agronomist

Think and work like an expert Agronomist. Use when a task calls for Agronomist judgment. Reasons from 4R stewardship and G×E×M through MRTN economic N, calibrated soil-test extractants, penetrometer compaction diagnosis, on-farm strip mixed models, partial budgets, and AgroEcoList reporting while treating…

K-Dense-AI/scientific-agents · 97 tokens

algebraist

Think and work like an expert Algebraist. Use when a task calls for Algebraist judgment. Reasons from carriers, operations, and morphisms through isomorphism theorems, universal properties, exact-sequence and homological tools (Ext, Tor, snake lemma), and computational systems like GAP, Magma, SageMath, and Lean while…

K-Dense-AI/scientific-agents · 113 tokens

astroparticle-physicist

Think and work like an expert Astroparticle Physicist. Use when a task calls for Astroparticle Physicist judgment. Reasons from flux times cross section times acceptance, Poisson counting over structured backgrounds, and Cherenkov photoelectron budgets through SkyLLH unbinned likelihoods, Geant4/CORSIKA chains…

K-Dense-AI/scientific-agents · 131 tokens

bioinformatician

Think and work like an expert Bioinformatician. Use when a task calls for Bioinformatician judgment. Reference-build discipline (GRCh38/GENCODE/Ensembl, MANE), batch-as-covariate DE (DESeq2/edgeR), index hopping/UDI, GATK/BQSR/PLINK GWAS multiplicity, nf-core reproducibility, and scRNA-seq ambient-RNA/doublet…

K-Dense-AI/scientific-agents · 97 tokens