doc-updates
Update documentation after code changes with quality gates, slop detection, consolidation, and accuracy verification
Install via CLI (Recommended)
clawhub install openclaw/skills/skills/athola/nm-sanctum-doc-updatesNight Market Skill — ported from claude-night-market/sanctum. For the full experience with agents, hooks, and commands, install the Claude Code plugin.
Table of Contents
- When to Use
- Required TodoWrite Items
- Step 1: Collect Context
- Step 2: Identify Targets
- Step 2.5: Check for Consolidation
- Step 3: Apply Edits
- Step 4: Enforce Guidelines
- Step 4.25: AI Slop Detection
- Step 4.75: Sync Capabilities Documentation
- Step 5: Verify Accuracy
- Step 6: Preview Changes
- Exit Criteria
- Flags
Documentation Update Workflow
When To Use
Use this skill when code changes require updates to the README, plans, wikis, or docstrings. Run Skill(sanctum:git-workspace-review) first to capture the change context.
System Capabilities
The documentation update workflow includes several specialized functions. It identifies redundancy through consolidation detection and enforces directory-specific style rules, with strict limits for docs/ and more lenient ones for the book/ directory. The system also verifies the accuracy of version numbers and component counts and integrates with the LSP for semantic documentation verification in supported versions of Claude Code.
When NOT To Use
- README-specific updates - use update-readme instead
- Complex multi-file consolidation - use doc-consolidation
Required TodoWrite Items
doc-updates:context-collected- Git context + CHANGELOG reviewdoc-updates:targets-identifieddoc-updates:consolidation-checked(skippable)doc-updates:edits-applieddoc-updates:guidelines-verifieddoc-updates:slop-scanned- AI marker detection via scribedoc-updates:plugins-synced- plugin.json ↔ disk auditdoc-updates:capabilities-synced- plugin.json ↔ documentation syncdoc-updates:accuracy-verifieddoc-updates:preview
Step 1: Collect Context (context-collected)
- Validate
Skill(sanctum:git-workspace-review)has been run. - Use its notes to understand the delta.
- Identify the features or bug fixes that need documentation updates.
CHANGELOG Reference (critical for version sync):
# Check recent CHANGELOG entries for undocumented features
head -100 CHANGELOG.md
# Compare documented version vs plugin versions
grep -E "^\[.*\]" CHANGELOG.md | head -3
for p in plugins/*/.claude-plugin/plugin.json; do
jq -r '"\(.name): \(.version)"' "$p"
done | head -5
Metadata
Not sure this is the right skill?
Describe what you want to build — we'll match you to the best skill from 16,000+ options.
Find the right skillPaste this into your clawhub.json to enable this plugin.
{
"plugins": {
"official-athola-nm-sanctum-doc-updates": {
"enabled": true,
"auto_update": true
}
}
}Related Skills
extract
Analyze a codebase and build a knowledge base of business logic, architecture, data flow, and engineering patterns. The foundation for gauntlet challenges and agent integration
discourse
>- Scan community discussion channels (HN, Lobsters, Reddit, tech blogs) for experience reports and opinions on a topic
synthesize
>- Merge, deduplicate, rank, and format research findings from multiple channels into a coherent report. Use after research agents return their results
workflow-monitor
Detect workflow failures and inefficient patterns, then create GitHub issues for improvement via /fix-workflow
architecture-paradigm-hexagonal
Hexagonal (Ports and Adapters) architecture isolating domain logic from infrastructure