han-update-documentation

Audit and update Han plugin documentation against skill and agent source files.

Updated Sep 1, 2026
One-click install
npx skills add https://github.com/amirbiron/Han --skill han-update-documentation-amirbiron
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: han-update-documentation
Source: https://github.com/amirbiron/Han/tree/main/.claude/skills/han-update-documentation
Command: npx skills add https://github.com/amirbiron/Han --skill han-update-documentation-amirbiron

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve? Keeping a multi-plugin repository's documentation in sync with its skills and agents is error-prone: long-form docs drift from SKILL.md frontmatter, indexes miss new entities, and cross-references break after renames. This skill automates that audit so every doc stays accurate after changes. ## Core Features & Use Cases - Branch-scoped or full-sweep audits: On a feature branch it audits only entities the branch touched; on the default branch it sweeps every skill, agent, index, and root doc. - Source-of-truth verification: Reads each SKILL.md or agent file first, then checks the long-form doc, index entries, and CLAUDE.md catalog against it, treating contradictions as functional bugs. - Cross-reference and bidirectional-link checks: Verifies sibling boundary statements, Related documentation pairings, and count-free references in README and concepts docs. - Use Case: After renaming a skill on a feature branch, run the skill to update the skill's long-form doc, the skills index, the CLAUDE.md catalog, and every sibling doc that referenced the old name. ## Quick Start Ask the assistant to run /han-update-documentation to audit and refresh the Han plugin docs for the changes on the current branch.

Frequently Asked Questions about han-update-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I update Han plugin documentation after changing a skill?▼

Run /han-update-documentation on your branch. It detects changed files against the default branch, maps them to affected documentation entities, audits each doc against its source SKILL.md or agent file, and applies fixes in place.

What is the difference between branch mode and sweep mode?▼

Branch mode runs on non-default branches and audits only entities the branch touched. Sweep mode runs on the default branch and audits every skill, agent, index, guidance doc, template, and root file across the plugin suite.

Can this skill document features in other projects?▼

No. It is a repository-maintenance skill scoped to the Han plugin repo itself. Use /project-documentation for arbitrary projects, /han-release for releases and CHANGELOG updates, and /update-pr-description for PR bodies.

What happens if a long-form doc is missing for a skill?▼

A missing long-form doc is a hard finding that blocks other checks for that entity. The skill creates the doc from docs/templates/skill-long-form-template.md or the agent template, filling sections from the frontmatter and leaving TODO markers for operator judgment.

Why does the skill stop with a mode error?▼

The detect script reports an error when git is not installed, the directory is not a git work tree, or origin/HEAD is not configured so the default branch cannot be determined. Resolve the reported reason and rerun inside the Han repository.