文档评审工作流

目标

代码变更应保持文档准确。本工作流找出因变更而变得不正确的文档、README 与示例，在同一变更中更新或在评审中明确标记后续工作，更新不再反映代码的内联注释与示例，并检查所引用的链接与锚点是否仍存在。

步骤要点

1. 找出因变更而过时的文档。
2. 同一变更更新或明确标记后续工作。
3. 更新不再准确的内联注释与示例。
4. 检查引用链接与锚点是否仍存在。

# check documentation links
npx markdown-link-check README.md

验证

按顺序执行上述步骤后，逐项确认每个步骤的预期状态均已满足；只有全部预期状态成立，才认为本流程完成。若某一步未达到预期状态，应先按排错提示排查，不要跳过继续，以免掩盖问题。

排错提示

• 过时文档会误导用户。
• 不检查链接会随时间腐坏。
• 标记的后续工作容易丢失。

适用边界

• 用户可见文档应阻断合并。
• 内部说明可仅提示。