跳到正文
cccskills
免费在 GitHub 公开

update-docs

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

中文简介正在准备中。当前显示原文说明。

查看安装方法

包含的文件(1)

  • SKILL.md2.5 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

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

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

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.

中文简介正在准备中。当前显示原文说明。

DGouron/review-flow442026年10月21日 更新

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

中文简介正在准备中。当前显示原文说明。

DGouron/review-flow442026年10月21日 更新

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.

中文简介正在准备中。当前显示原文说明。

DGouron/review-flow442026年10月21日 更新

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

中文简介正在准备中。当前显示原文说明。

DGouron/review-flow442026年10月21日 更新

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.

中文简介正在准备中。当前显示原文说明。

DGouron/review-flow442026年10月21日 更新

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.

中文简介正在准备中。当前显示原文说明。

DGouron/review-flow442026年10月21日 更新

查看 DGouron 的全部技能

报告此技能的问题