documenting-projects

documenting-projects is a skill for Claude Code, Codex from axiomantic/spellbook. It costs 93 tokens per session (2,745 once invoked), scanned A, original, MIT.

A method for creating, improving, and auditing documentation for a software project, including READMEs, tutorials, API references, and documentation reviews.

In plain words
What is it for?
Use it to generate new documentation, update outdated docs, or check an existing documentation set.
Why use it?
It helps keep project information accurate, organized, and consistent with the intended type of document.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one. Also seen: mentions subagents.

Good fit Use it to generate new documentation, update outdated docs, or check an existing documentation set.

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

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 documenting-projects

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

Your own site · 80×15
<a href="https://agentmods.dev/skills/axiomantic/spellbook/documenting-projects"><img src="https://agentmods.dev/badge/skills/axiomantic/spellbook/documenting-projects.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 93 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,745 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. Third-party audits
  • NVIDIA SkillSpector warn 7 Sept 2026
SkillSpector: 1 finding, up to medium

These are SkillSpector’s own severities. On a checked sample its high-severity flags on skills were ~96% false positives — a documented command, a public API, a “never do X” rule — so we show them as a caution to read, not a verdict. Why →

  • medium Rogue Agent · line 108
    Skill establishes unauthorized persistence across sessions via cron jobs, startup scripts, or state files. Session persistence allows an attacker to maintain access beyond the current interaction.
    Fix: Remove any persistence mechanisms (cron jobs, startup scripts, state files). Skills should not maintain state across sessions without explicit user consent.
How audits are shown
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.00093 $0.02745
Opus 5.5 $0.00037 $0.01098
Sonnet 5.5 $0.00019 $0.00549
Haiku 4.5 $0.00009 $0.00275

Measured 1mo ago against content hash 6ab6f9084d04, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

documenting-projects 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 1mo 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/documenting-projects/SKILL.md · 322 lines

How it starts

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

Documenting Projects

Announce: "Using documenting-projects skill for documentation generation."

<BEHAVIORAL_MODE> ORCHESTRATOR: Dispatch subagents via Task tool for ALL documentation work. Each subagent invokes its phase command via the Skill tool (e.g., Skill("docs-audit")). Never write documentation directly. Never invoke phase commands directly from the orchestrator. Context should contain only Task dispatches, user communication, and phase transitions. </BEHAVIORAL_MODE>


Invariant Principles

  1. Diataxis First: Every document maps to exactly one Diataxis type. Mode mixing is a defect.
  2. Tone is Non-Negotiable: Each section follows its assigned tone profile. Deviations trigger re-generation.
  3. Writing Guide Rules Apply to ALL Content: No banned phrases, no hedging, no marketing language. Enforced during generation, not as an afterthought.
  4. Quality Gates Must Pass Before Docs Ship: All 8 review criteria evaluated, all must pass or user explicitly accepts known issues.
  5. Output Goes to Project Repo: Documentation files are project deliverables, not spellbook artifacts. Write directly to the project's docs directory.

Phase Overview

Phase Command Purpose MVP
1 /docs-audit Project analysis, gap identification Yes
2 /docs-plan TOC, tooling, tone assignment Yes
3 /docs-write Section generation with tone profiles Yes
4 /docs-review 8-criterion quality gate Yes

Read the full file on GitHub · 322 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. 1mo ago First seen · 322 lines · 93 tokens per session scan A 6ab6f9084d04

Subscribe to this mod's changes

documenting-projects is a skill published in the GitHub repository axiomantic/spellbook (10 stars, last pushed 2d ago), licensed MIT. It adds 93 tokens to every session and 2,745 once invoked, about $0.0004 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-09-03.