Skip to content
cccskills
FreePublished on GitHub

update-docs

Update documentation after code changes. Scans git diff to find affected docs and updates them for consistency.

The English summary is being prepared. Showing the original description.

See how to install

Files included (1)

  • SKILL.md2.5 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

Update Documentation

Activation

This skill activates for:

  • Updating docs after a code change
  • Synchronizing documentation with the current code state
  • /update-docs

Persona

Read .claude/roles/documentalist.md — adopt this profile and follow all its rules.

Workflow

Step 1: Identify Code Changes

# Default: last 5 commits. The user can specify a range.
git diff --name-only HEAD~5

Filter relevant files (ignore: tests, configs, lock files).

Step 2: Map Changes to Docs

Two strategies, in this order:

Strategy A — Frontmatter related (priority):

# Read the frontmatter of each doc
Glob docs/**/*.md
# Look for modified files in the `related` field

Strategy B — Keyword search (fallback):

  • Extract entity/module names from modified files
  • Search for those terms in the doc content
  • E.g., if mcpServerStdio.ts changed, search for "mcp", "server", "stdio" in docs

Step 3: Evaluate Impact

For each potentially affected doc:

QuestionIf Yes
Has the documented behavior changed?Update required
Has a documented API/interface changed?Update required
Only internal implementation changed?No update needed
Has a new concept appeared?Suggest /create-doc

Step 4: Update

For each doc to modify:

  1. Read the entire doc and the modified source code
  2. Update only the affected sections
  3. NEVER add content that exists in another doc — link instead
  4. Update last-updated in the frontmatter
  5. Verify that related entries are up to date (add new files if needed)

Step 5: Add Missing Frontmatter

If a doc has no YAML frontmatter, add it following the template from PERSONA.md. This is a progressive migration — no need to do everything at once.

Step 6: Report

List the modifications made:

## Docs Updated

| File | Changes | Reason |
|------|---------|--------|
| docs/MCP-TOOLS-REFERENCE.md | Updated tool parameters | mcpServerStdio.ts changed |
| docs/ARCHITECTURE.md | No update needed | Internal refactor only |

Rules

  • Do not translate existing French docs unless explicitly requested
  • Do not restructure an entire doc — modify only what is affected
  • If a doc is massively obsolete, recommend /audit-docs first
  • Always keep the existing structure unless it violates the template

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

Guide for creating optimized Claude Code agents. Use to design a new specialized agent, a swarm sub-agent, or a multi-agent workflow. Follows the Skill → Agent (preloaded skills) → Skill orchestration pattern.

The English summary is being prepared. Showing the original description.

DGouron/review-flow44Updated Oct 21, 2026

Anti-overengineering guide based on YAGNI. Use before adding an architectural pattern, during code review, or to challenge an overly complex implementation.

The English summary is being prepared. Showing the original description.

DGouron/review-flow44Updated Oct 21, 2026

Clean Architecture (Uncle Bob) guide for this project. Use when creating modules, entities, use cases, presenters, controllers, gateways, guards, services. Contains tactical patterns and structure conventions.

The English summary is being prepared. Showing the original description.

DGouron/review-flow44Updated Oct 21, 2026

Audit documentation for duplication, staleness, language issues, and verbosity. Read-only — produces an actionable report.

The English summary is being prepared. Showing the original description.

DGouron/review-flow44Updated Oct 21, 2026

Local auto-review of modified code (no GitLab/GitHub). Runs 5 sequential audits and generates a local report. Ideal for validating code before creating a MR/PR.

The English summary is being prepared. Showing the original description.

DGouron/review-flow44Updated Oct 21, 2026

Clean Code (Robert C. Martin) guide to produce and challenge code that is readable, durable, simple, and consistent. Covers naming, functions, comments, smells, and refactor heuristics. Complements `/solid` (SOLID principles) and `/anti-overengineering` (YAGNI/KISS). Activate during the REFACTOR phase of the TDD cycle and during implementation self-review.

The English summary is being prepared. Showing the original description.

DGouron/review-flow44Updated Oct 21, 2026

See all skills by DGouron

Report a problem with this skill