본문으로 건너뛰기
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(원문)

설치하기 전에 에이전트에게 전달되는 지시 내용을 확인할 수 있습니다.

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 / 1,000자

이 양식은 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의 스킬 모두 보기

이 스킬의 문제 신고