Agent skill
update-doc
Use when user says 'update docs', 'sync documentation', 'refresh docs', or after code changes need documenting. Updates llmdoc system based on recent code changes.
Stars
163
Forks
31
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/data/update-doc
SKILL.md
/update-doc
This skill updates the project's llmdoc documentation to reflect recent code changes.
Pre-fetched Context
- Llmdoc structure: !
find llmdoc -name "*.md" 2>/dev/null | head -50 - Recent changes (3 commits): !
git diff HEAD~3..HEAD --stat 2>/dev/null | head -30 - Affected files: !
git diff HEAD~3..HEAD --name-only 2>/dev/null | head -30 - Llmdoc index: !
cat llmdoc/index.md 2>/dev/null | head -50
Actions
-
Step 1: Analyze Changes
- If
$ARGUMENTSis provided, use it as the description of what changed. - Otherwise, analyze the pre-fetched git diff to understand what changed.
- If
-
Step 2: Identify Impacted Concepts
- Map changed files to llmdoc concepts:
- Config files (
.eslintrc, etc.) →reference/coding-conventions.md - Auth files → relevant architecture docs
- New features → may need new docs
- Config files (
- Create a list of impacted documents.
- Map changed files to llmdoc concepts:
-
Step 3: Update Documents
- For each impacted document, use
recorderagent with this prompt:Task: Update documentation for <concept_name>. Changes: <relevant git diff summary> Mode: content-only Principle: Use fewest words necessary.
- For each impacted document, use
-
Step 4: Synchronize Index
- After all updates complete, invoke a single
recorderagent to:- Re-scan
/llmdocdirectory - Ensure
index.mdis consistent and up-to-date - Mode: full
- Re-scan
- After all updates complete, invoke a single
-
Step 5: Report
- Summarize all documents created/updated/deleted.
Update Principles
- Minimality: Use fewest words necessary
- Accuracy: Based on actual code, not assumptions
- No Code Blocks: Reference with
path/file.ext:lineformat - LLM-Friendly: Write for machine consumption
Didn't find tool you were looking for?