documentation

documentation is a skill for Claude Code, Codex from paruff/uFawkesAI. It costs 72 tokens per session (2,106 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

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/paruff/ufawkesai/documentation
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.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.svg" alt="Measured on agentmods" 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,106 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.00072 $0.02106
Opus 5 $0.00036 $0.01053
Sonnet 5 $0.00014 $0.00421
Haiku 4.5 $0.00007 $0.00211

Measured 4d ago against content hash 94bd0e2264c7, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, 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 4d 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. 4d 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 12d ago), licensed MIT. It adds 72 tokens to every session and 2,106 once invoked, about $0.0004 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

planning-with-files

Persistent file-based planning for multi-step AI-agent work. Keeps taskplan.md, findings.md, and progress.md on disk; lifecycle hooks inject selected project planning context. Automatic recovery reads project planning files only. Explicit session-catchup.py --metadata reads same-project local agent session records and…

mxyhi/ok-skills · 117 tokens

infrastructure-overview

Top-level skill for the research template infrastructure layer. Use in Cursor, Claude Code, or similar agents when editing or importing anything under infrastructure/, understanding the two-layer architecture, or wiring build/validation/rendering/publishing. Covers module discovery, import patterns, thin…

docxology/template · 80 tokens

infrastructure-validation

Skill for the validation infrastructure module providing PDF validation, markdown validation, output integrity checks, link verification, documentation audits, issue categorization, and repository scanning. Use when validating research outputs, checking document quality, running audits, or verifying cross-references.

docxology/template · 54 tokens

infrastructure-tools

Skill for the tools module — discovery, validation, scope, and private-sidecar symlink sync for the top-level tools/ directory (executable entry points such as scripts, skills, and agents stored as passive manifests with scripts/ directories). Use when discovering tools (discovertools), resolving a tool path…

docxology/template · 168 tokens

template-academic-paper

Template-native manuscript planning, outline, drafting, revision, formatting, citation check, and AI-use disclosure routing. USE WHEN the user asks to write, outline, revise, format, or prepare a paper inside the Research Project Template.

docxology/template · 52 tokens

infrastructure-reference-citation

BibTeX read/write/convert that matches the syntax/semantics of projects/templates/templatecodeproject/manuscript/references.bib (consumed by Pandoc with --natbib -- see infrastructure/rendering/pdfcombinedrenderer.py). Provides BibEntry/BibDatabase models, parsebibfile/renderdatabase functions, papertobibentry…

docxology/template · 142 tokens