generate-user-docs

generate-user-docs is a skill for Claude Code from rp1-run/rp1. It costs 29 tokens per session (2,670 once invoked), scanned A, original, Apache-2.0.

A documentation workflow that compares user-facing documents with a knowledge base and coordinates updates when they are outdated. It uses scanning, approval, and processing stages.

In plain words
What is it for?
Use it to review documentation against current reference material, approve proposed changes, and coordinate file-level updates.
Why use it?
It helps find stale documentation and prevents updates from being made silently when the knowledge base itself may be outdated.

Skill for Claude Code

Written for Claude Code: allowed-tools in frontmatter. Also seen: mentions AGENTS.md.

Part of the rp1-base plugin — 20 skills, 17 agents, 1 hook shipped together

Good fit Use it to review documentation against current reference material, approve proposed changes, and coordinate file-level updates.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/rp1-run/rp1/generate-user-docs
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 rp1-run/rp1 --skill generate-user-docs
Clone the repo
git clone --depth 1 https://github.com/rp1-run/rp1

Made for: Claude Code.

Or install rp1-base, the plugin that ships this one along with the rest of its 20 skills, 17 agents, 1 hook.

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 generate-user-docs

README.md
[![agentmods](https://agentmods.dev/badge/skills/rp1-run/rp1/generate-user-docs.svg)](https://agentmods.dev/skills/rp1-run/rp1/generate-user-docs)
Your own site
<a href="https://agentmods.dev/skills/rp1-run/rp1/generate-user-docs"><img src="https://agentmods.dev/badge/skills/rp1-run/rp1/generate-user-docs.svg" alt="Measured on agentmods" height="20"></a>
Per session 29 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,670 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 pass 7 Sept 2026
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.00029 $0.02670
Opus 5 $0.00015 $0.01335
Sonnet 5 $0.00006 $0.00534
Haiku 4.5 $0.00003 $0.00267

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

Security

Grade A, and why

generate-user-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 8d 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.

plugins/base/skills/generate-user-docs/SKILL.md · 357 lines

How it starts

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

Generate User Docs

§ROLE: User-doc sync orchestrator. Reconcile user-facing docs against {kbRoot}/ in one scan pass and one process pass.

§OBJ

  • Sync docs to current KB facts
  • Keep orchestration state under {workRoot}/
  • Delegate file-level scan/process only
  • Ask approval exactly once after scan
  • If the KB is stale but structurally valid, require one explicit pre-scan decision gate

§DO

  • Execute discovery + scan immediately
  • Use rp1-base:scribe only for file batches
  • Spawn scan/process batches in parallel with background dispatch
  • When the KB is stale, warn with a three-way gate: continue, rebuild first, or cancel
  • Keep user-visible output terse:
    1. KB validation status
    2. Scan summary + approval gate
    3. Final report
  • Preserve scan_results.json; do NOT delete it automatically

§DONT

  • Do NOT ask approval before scan
  • Do NOT edit docs directly in the parent
  • Do NOT iterate on scan or process more than once
  • Do NOT silently continue with a stale KB
  • Do NOT treat diffs inside the docs being reconciled as KB-staleness signals for this run

§PATHS

  • Use the RUN_ID from the generated Workflow Bootstrap section
  • Derive RUN_NAME as "Docs: sync user docs" (max 60 chars)
  • Set DATESTAMP to the current date in YYYY-MM-DD
  • Set SESSION_DIR=docs-sync/{DATESTAMP}-{RUN_ID}
  • Set SCAN_RESULTS_REL={SESSION_DIR}/scan_results.json
  • Set SCAN_RESULTS_PATH={workRoot}/{SCAN_RESULTS_REL}

References

File Purpose When to Load
references/kb-validation.md KB staleness gate, missing-file handling, format checks When the validate step runs
references/processing.md Per-doc update procedure, artifact registration, completion reporting After approval returns an approved change set

STATE-MACHINE

stateDiagram-v2
    [*] --> discover
    discover --> validate_kb : docs_ready
    discover --> failed : no_docs
    validate_kb --> scan : kb_current
    validate_kb --> stale_kb_gate : kb_stale
    validate_kb --> failed : kb_invalid
    stale_kb_gate --> scan : continue_with_stale
    stale_kb_gate --> cancelled : rebuild_requested
    stale_kb_gate --> cancelled : rejected
    scan --> approve : results_written
    scan --> failed : scan_failed
    approve --> process : approved
    approve --> cancelled : rejected
    process --> finalize : processing_done
    process --> failed : process_failed
    finalize --> [*] : done
    failed --> [*] : stopped
    cancelled --> [*] : stopped

Read the full file on GitHub · 357 lines

Files

What ships with it

2 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. 8d ago First seen · 357 lines · 29 tokens per session scan A 8e0ce3dd1285

Subscribe to this mod's changes

generate-user-docs is a skill published in the GitHub repository rp1-run/rp1 (38 stars, last pushed yesterday), licensed Apache-2.0. It adds 29 tokens to every session and 2,670 once invoked, about $0.0001 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-30.

Related

Other skills, from other repositories

skill-curator

A Chinese-language evaluator for deciding whether developer tools and agent resources are suitable for a curated collection. It checks real repositories, installation paths, activity, duplicates, and security boundaries using evidence.

laolaoshiren/claude-code-skills-zh · 75 tokens

git-workflow

A guide for handling Git repository work safely, including status checks, branches, commits, pushes, pull requests, and rebasing. Git is a version-control system that records code changes and coordinates work between developers.

laolaoshiren/claude-code-skills-zh · 73 tokens

i18n-helper

A helper for adding internationalization, which lets software show different languages and regional text. It finds user-visible text written directly in code and moves it into language files.

laolaoshiren/claude-code-skills-zh · 33 tokens

brainstorm

Explore ambiguous or early-stage ideas interactively — tracks wish-readiness and crystallizes into a design for wish.

automagik-dev/genie · 25 tokens

refactor-advisor

A code review helper that finds common design and maintenance problems in a codebase and suggests ways to restructure the code.

laolaoshiren/claude-code-skills-zh · 22 tokens

acceptance-test-authoring

Use when creating or modifying acceptance tests, configuring cucumber-js or behave runners, writing or refactoring step definitions, linting executable Gherkin specs, choosing an acceptance stack, or implementing OpenSpec tasks that involve acceptance tests.

intent-driven-dev/intent-driven-template · 51 tokens