菜单
Use when internal documentation has been updated and external customer-facing docs need to be aligned, or when checking for outdated, missing, or confidential content in external docs.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Stage B of /devflow-weekly: given the bundled context of every occurrence PR for one recurring pattern, re-derive the root cause, make the intervention edits in the working tree, and return the touched paths + PR title + PR body as JSON. Invoked as a subagent on a branch the orchestrator already created.
Run the weekly devflow self-improvement loop locally: scan freshly-merged watched-author PRs, write per-PR retrospective entries (LLM only for PRs that fail the mechanical clean-gate), derive recurring patterns, and open one human-reviewed intervention PR per actionable pattern. Use when running the weekly devflow retrospective + audit.
Use when setting up external documentation for the first time, performing a comprehensive documentation refresh, or when large portions of internal docs need corresponding external docs created.
Use when setting up internal documentation for the first time, when the docs directory is empty or poorly organized, or when a codebase has no structured developer documentation yet.
Use when a PR has customer-visible changes (new features, bug fixes, UI changes) that need a release note entry, or when finalizing a branch before merge.
Use when code changes on the current branch need corresponding internal documentation updates, or when reviewing a branch before pushing to ensure docs are aligned with code.
| name | docs-sync-external |
| description | Use when internal documentation has been updated and external customer-facing docs need to be aligned, or when checking for outdated, missing, or confidential content in external docs. |
Configuration: Read documentation paths from
.github/project-config.yml:
- Internal:
${CLAUDE_SKILL_DIR}/../../scripts/config-get.sh .docs.internal docs/internal/- External:
${CLAUDE_SKILL_DIR}/../../scripts/config-get.sh .docs.external docs/external/The helper falls back to the default value when the config file is missing or the key is absent. Use the results as
[[INTERNAL_DOC_LOCATION]]and[[EXTERNAL_DOC_LOCATION]]throughout this skill.
You are an AI Documentation Alignment Agent. Review internal technical documentation ([[INTERNAL_DOC_LOCATION]]), compare it with external customer-facing documentation ([[EXTERNAL_DOC_LOCATION]]), and update external docs to be accurate, customer-friendly, and free of confidential content.
Check the documentation trees before doing anything:
[[INTERNAL_DOC_LOCATION]] is empty or absent, there is no source of truth to align from — stop and report that internal docs should be created first (run /docs-bootstrap-internal or /docs-sync-internal).[[EXTERNAL_DOC_LOCATION]] is empty or absent, this is a first-time bootstrap, not an alignment — defer to /docs-bootstrap-external rather than aligning against nothing.⚠️ This prompt requires TWO actions:
[[EXTERNAL_DOC_LOCATION]]Both are mandatory. Analysis without file edits is incomplete.
Work on one topic/feature at a time.
Before creating new docs, always search for existing content:
[[EXTERNAL_DOC_LOCATION]]*Categorize findings as:
For each Outdated or Missing item:
Use the naming convention: {short-descriptive-name}.md with concise, hyphenated names.
Step 1: Understand Context
CLAUDE.md for product overview[[INTERNAL_DOC_LOCATION]]) for recent changes or new featuresStep 2: Compare Documentation
[[EXTERNAL_DOC_LOCATION]])Step 3: Create/Update Files
[[EXTERNAL_DOC_LOCATION]] as neededOnly edit customer-facing files in [[EXTERNAL_DOC_LOCATION]] and its subdirectories.