菜单
Use when documentation needs syncing — user says "sync docs", "update docs", "doc sweep", or invoked from a prompt snippet at session end. Scoped to what changed this session only, not a full project sweep. NOT a design journal update (java-git-commit handles that).
默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。
决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
直接命令不会经过审查 Prompt；运行前请先检查来源。
npx skills add https://github.com/mdproctor/cc-praxis --skill implementation-doc-sync命令会保持在同一行。复制前请横向滚动并检查完整内容。
想先保存到本地？可下载 SkillsMP 当前能够提供的文件。
Use when the user says "review the code", "check these changes", "review this", "look at staged changes", or invokes /code-review. Also invoked automatically by git-commit skills if no review has been done this session. Applies to Java/Quarkus, TypeScript, and Python projects.
Use when the user says "bump a version", "upgrade dependencies", "check for newer versions", "add a dependency", or "run audit" — for Java/Maven, TypeScript/npm, or Python/pip projects. Routes to the correct package manager based on project type declared in CLAUDE.md.
Use when user wants to create a commit NOW — says "commit this", "commit these changes", "create a commit". Routes to Java or custom project workflows when CLAUDE.md declares those types; falls back to generic commit for all others. Does NOT apply to discussions about past commits or questions about whether to commit.
基于 SOC 职业分类
正在显示 SKILL.md
| name | implementation-doc-sync |
| description | Use when documentation needs syncing — user says "sync docs", "update docs", "doc sweep", or invoked from a prompt snippet at session end. Scoped to what changed this session only, not a full project sweep. NOT a design journal update (java-git-commit handles that). |
| slash-command | false |
Answer the question: given what changed this session, which docs need to catch up?
Scope is intentionally narrow — only docs that cover the components, capabilities, or conventions that were modified. Sweeping unrelated docs wastes time and creates noise.
Identify what changed. Use git and conversation context — do not guess.
# What repos have uncommitted or recently committed changes?
git log --oneline --since="8 hours ago"
git diff --name-only HEAD~5..HEAD 2>/dev/null | head -30
From this, extract:
Store this as the session scope. Everything below is filtered through it.
Run before checking any docs. Every doc identified in Step 2 must be checked against this boundary — peer-repo docs are never edited directly.
Run the bundled context script to resolve the home repo path:
python3 ~/.claude/skills/project-init/ctx.py
A doc is in the home repo if its absolute path starts with <WORKSPACE>/.
A doc is in a peer repo if its path starts with a sibling directory
(e.g. ../parent/, ../engine/, ../ledger/) or any other git root
outside $HOME_REPO.
Rule:
The CLAUDE.md of the current session may explicitly list peer repos (look for "Never commit or push to peer repo directories" or a similar rule). If listed, treat every repo on that list as peer-repo regardless of path analysis.
Use this mapping to identify which docs are in scope. Only include docs that directly cover something in the session scope.
The Location column tells you where each doc lives. Home-repo docs are fixed directly. Peer-repo docs are read for reference and any needed changes are filed as GitHub issues — never committed from this session.
| Change type | Docs to check | Location |
|---|---|---|
| New capability or feature | docs/PLATFORM.md → Capability Ownership table | peer repo (parent) |
| New or changed cross-repo dependency | docs/PLATFORM.md → Cross-Repo Dependency Map | peer repo (parent) |
| Repo renamed / restructured | docs/PLATFORM.md → Repository Map | peer repo (parent) |
| Per-repo deep dive affected | docs/repos/casehub-{repo}.md | peer repo (parent) |
| Application tier change | docs/APPLICATIONS.md | peer repo (parent) |
| New platform protocol | docs/protocols/INDEX.md + the protocol file itself | home repo |
| Existing protocol updated | The protocol file + any files that reference it | home repo |
| Convention or workflow change | CLAUDE.md (invoke update-claude-md) | home repo |
| Architecture decision | adr/ (invoke adr if not yet recorded) | home repo |
| Design journal (epic branch) | design/JOURNAL.md (invoke java-update-design) | home repo |
| Maven coordinate change | docs/protocols/maven-coordinate-standard.md if convention changed | home repo |
| Cross-repo artifact rename | docs/PLATFORM.md → Cross-Repo Dependency Map | peer repo (parent) |
Note on the Location column: The entries marked "peer repo (parent)" apply
to the casehubio platform layout where docs/PLATFORM.md lives in the parent
repo. For other project layouts, apply the Step 1b boundary check to confirm
whether a given doc path is inside $HOME_REPO or not.
If a doc type is not in this table and not obviously related to the session scope, skip it.
For each doc identified in Step 2, run this checklist:
Route each issue by location before acting:
replace_text_in_file for targeted edits; Edit tool for structured
doc sectionsFor any gap found in a peer-repo doc (e.g. docs/PLATFORM.md in the parent repo):
gh issue create --repo <owner/peer-repo> --title "docs: sync <doc-name> for <feature>" \
--body "## What to update\n\n<exact change needed>\n\n## Context\n<why this change is needed>"
After all actions, report a brief summary:
Doc sync complete — {n} docs checked, {n} updated, {n} issues filed:
- docs/protocols/INDEX.md: added artifact-rename-propagation.md entry [home repo — fixed]
- CLAUDE.md: updated connector exclusion pattern [home repo — fixed]
- docs/PLATFORM.md: cross-repo dependency row needed [peer repo — issue #N filed on casehubio/parent]
- docs/repos/casehub-clinical.md: deep-dive needs sponsor notification note [peer repo — issue #N filed on casehubio/parent]
- (no changes needed): docs/APPLICATIONS.md
If a gap requires more than a doc update (e.g. a missing ADR for a significant
decision), flag it: "ADR not yet recorded for X — invoke adr to capture it."
Do not silently skip it.
Before staging anything, verify you are in the home repo:
CURRENT=$(git rev-parse --show-toplevel)
echo "Committing to: $CURRENT"
# Confirm this matches $HOME_REPO from Step 1b
If the current directory is not the home repo, cd to it explicitly before
staging. Never run git add from inside a peer repo directory.
If any home-repo docs were updated, commit them separately from code changes:
git -C "$HOME_REPO" add docs/
git -C "$HOME_REPO" commit -m "docs: sync documentation to session changes
[brief description of what was updated and why]
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>"
Docs and code in separate commits keeps the history readable.
Peer-repo changes are never committed here — they were filed as GitHub issues in Step 4 and are the responsibility of the peer repo's session.
project-healthjava-update-design (via java-git-commit)update-claude-md
(but it will invoke those skills if the session scope triggers them)adrsuperpowers:requesting-code-reviewInvoked by: prompt snippet at end of implementation session; user says "sync docs", "update docs", "doc sweep"
Invokes when triggered by session scope:
update-claude-md — if conventions or workflows changedjava-update-design — if on an epic branch and design decisions were madeadr — if a significant architectural decision lacks a recordComplements:
project-health — full project correctness check (not session-scoped)java-git-commit — chains to java-update-design for design journalwork-end — runs this as part of Step 3b pre-close sweep; writes HANDOFF.md afterhandover — runs this as part of the wrap checklist (mid-work sessions only)