doc-updates | sanctum | ClaudePluginHub

Skill

Community

doc-updates

11

Description

Update documentation files based on recent changes while enforcing project writing guidelines. Triggers: documentation update, docs update, ADR, docstrings, writing guidelines, readme update, documentation maintenance Use when: updating documentation after code changes, enforcing writing guidelines, maintaining ADRs, updating docstrings DO NOT use when: README-specific updates - use update-readme instead. DO NOT use when: consolidating ephemeral docs - use doc-consolidation. Use this skill for general documentation updates.

Install

1

Add the repository(one-time)

$

/plugin marketplace add athola/claude-night-market

2

Install the plugin

$

/plugin install pensive@claude-night-market

Tool Access

This skill inherits all available tools. When active, it can use any tool Claude has access to.

Supporting Assets

View in Repository

modules/adr-patterns.md

Skill Content

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.

Required TodoWrite Items

doc-updates:context-collected
doc-updates:targets-identified
doc-updates:edits-applied
doc-updates:guidelines-verified
doc-updates:preview

Step 1: Collect Context (`context-collected`)

Ensure 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.

Step 2: Identify Targets (`targets-identified`)

List the relevant files from the scope (e.g., README.md, wiki entries, docstrings).
Prioritize user-facing documentation first, then supporting plans and specifications.
When architectural work is planned, confirm whether an Architecture Decision Record (ADR) already exists in wiki/architecture/ (or wherever ADRs are located).
Add missing ADRs to the target list before any implementation begins.

Step 3: Apply Edits (`edits-applied`)

Update each file with grounded language: explain what changed and why.
Reference specific commands, filenames, or configuration options where possible.
For docstrings, use the imperative mood and keep them concise.
For ADRs, see modules/adr-patterns.md for complete template structure, status flow, immutability rules, and best practices.

Step 4: Enforce Guidelines (`guidelines-verified`)

Re-read the project's style rules (no filler phrases, avoid abstract adjectives, etc.).
Ensure the balance between bullet points and paragraphs matches the guidance.
Remove emojis and checkmarks; replace them with text equivalents.

Step 5: Preview Changes (`preview`)

Show diffs for each edited file (git diff <file> or rg snippets).
Summarize remaining TODOs or follow-ups.

Exit Criteria

All TodoWrite items are completed and documentation is updated.
New ADRs, if any, are in wiki/architecture/ (or the established ADR directory) with the correct status and links to related work.
Guidelines are satisfied, and the content does not sound AI-generated.
Files are staged or ready for review.

Links

GitHub Stats

2 forks

Similar Skills

Agent Development

This skill should be used when the user asks to "create an agent", "add an agent", "write a subagent", "agent frontmatter", "when to use description", "agent examples", "agent tools", "agent colors", "autonomous agent", or needs guidance on agent structure, system prompts, triggering conditions, or agent development best practices for Claude Code plugins.

47.1k

Command Development

This skill should be used when the user asks to "create a slash command", "add a command", "write a custom command", "define command arguments", "use command frontmatter", "organize commands", "create command with file references", "interactive command", "use AskUserQuestion in command", or needs guidance on slash command structure, YAML frontmatter fields, dynamic arguments, bash execution in commands, user interaction patterns, or command development best practices for Claude Code.

47.1k

Hook Development

This skill should be used when the user asks to "create a hook", "add a PreToolUse/PostToolUse/Stop hook", "validate tool use", "implement prompt-based hooks", "use ${CLAUDE_PLUGIN_ROOT}", "set up event-driven automation", "block dangerous commands", or mentions hook events (PreToolUse, PostToolUse, Stop, SubagentStop, SessionStart, SessionEnd, UserPromptSubmit, PreCompact, Notification). Provides comprehensive guidance for creating and implementing Claude Code plugin hooks with focus on advanced prompt-based hooks API.

47.1k