在每次 PR 变更时评估文档影响,并给出可落地的更新建议。
复制安装指令,让 AI 自动完成配置 · 推荐新手
请帮我安装 askskill 上的 "docs-sync" 技能: 1. 下载 https://raw.githubusercontent.com/microsoft/apm/main/.apm/skills/docs-sync/SKILL.md 2. 保存为 ~/.claude/skills/docs-sync/SKILL.md 3. 装好后重载技能,告诉我可以用了
请针对这个 PR 评估文档是否需要更新。即使标题和描述没提文档,也要检查代码变更是否会导致文档失真。请将影响分类为:无需修改、局部改写、结构性变更,并给出涉及页面、建议修改点和可直接用于补丁的说明。
一份文档影响评估,包含影响等级、受影响文档位置、修改建议及后续协作说明。
这个 PR 主要是内部实现调整,但我担心会引起文档静默漂移。请检查用户可见行为、配置、参数、返回结果或流程是否发生变化,并判断现有文档是否仍然真实准确。
对潜在文档漂移的判断,以及是否需要补充或修正文档的明确结论。
请分析这个 PR 带来的功能变化是否超出原有页面可承载范围。如果需要新增文档页面或调整目录结构,请说明原因、建议的信息架构,以及应由哪些角色参与完成文档更新。
关于是否需要新页面或目录调整的结论,以及结构化的文档更新方案。
The docs corpus drifts silently and constantly. This skill catches drift at PR-open time, classifies its impact, and orchestrates a persona panel to produce a patch-ready advisory comment.
The pattern is A1 PANEL + B1 FAN-OUT/SYNTHESIZER + A8 ALIGNMENT LOOP. The classifier is the cost gate (~70% of PRs short-circuit to no-change with ~1 LLM call). When the panel does fan out, every agent reads a bounded context (~10 KB) -- never the full corpus.
This skill is ADVISORY. It does not gate merge, apply verdict labels, or push to the contributor's fork. The orchestrator is the sole writer to the PR: exactly one comment per run (idempotent edit-in-place), plus optional label sweeps.
N/15 for observability.gh write command, post comments, or touch PR state.## Docs sync advisory. Re-runs edit-in-place using gh pr comment --edit-last.docs-sync-confirm label) open from a bot branch in the BASE repo; never pushed to the contributor's fork..apm/docs-index.yml, NOT the corpus itself. The corpus is sampled only by the localizer (which reads the specific candidate pages) and by per-page panelists (which read one page each).apm --help, grep, and python -c commands to verify doc claims, never assert from prose.| Role | Agent | Always active? |
|---|---|---|
| Classifier | doc-analyser inside docs-impact-classifier | Yes (every run) |
| Localizer | docs-impact-localizer | Only on in_place verdict |
| Architect | docs-impact-architect | Only on structural verdict |
| Writer | doc-writer | Per candidate page (fan-out) |
| Verifier | python-architect | Per candidate page (fan-out, S7) |
| Editorial | editorial-owner | Once across all redrafts |
| Growth | oss-growth-hacker | Once across all redrafts |
| Synthesizer | cdo | Once, with ALIGNMENT LOOP up to 3 redrafts |
docs-sync SKILL (orchestrator thread)
|
Step 1: classify (1 LLM call, may exit here)
|
v
verdict?
/ | \
no-change in-place structural
| | |
EXIT | architect (TOC delta)
| |
+----<-----+
|
Step 2: localize (1 LLM call) -- per-page task brief
|
Step 3: FAN-OUT panel via task tool
|
+----+----+----+----+
v v v v v
writer verify edit growth
x N x N once once
(parallel; each <=10 KB context)
|
Step 4: schema-validate returns
|
Step 5: CDO synthesize (1 LLM call)
|
agree?
/ | \
revise (N<=3 redrafts) | agree
|
Step 6: emit ONE comment via safe-outputs.add-comment
Step 7: OPTIONAL companion docs PR (only if structural AND
`docs-sync-confirm` label present)
Spawn ONE task: load the docs-impact-classifier skill, pass it the
…
帮助开发团队快速分诊 microsoft/apm 新开或待分诊问题并生成统一处理意见
核查回答是否有文档依据,帮助发现未被资料支持的内容与引用问题。
将文档影响判定细化为逐页逐段的同步执行任务清单
帮助团队制定 APM 项目定位、发布沟通与破坏性变更决策策略。
对整套技术文档逐页对照源码审计,并给出精准过时内容修复建议
批量梳理并分诊 APM 仓库问题,将明确事项推进到可合并 PR。
在文档结构需随 PR 调整时,规划目录变更并生成新页面大纲草案。
快速判断代码变更对文档的影响级别,决定是否需要同步更新文档
为 microsoft/apm 的拉取请求自动撰写结构完整、证据充分的 PR 描述。
对 microsoft/apm 的标记 PR 发起多专家联合审查并给出综合建议
引导用户协作撰写文档、方案与技术规格,并通过迭代完善内容质量。
帮助团队持续维护代码仓库文档、进度记录与交接上下文,便于协作开发