返回技能库
内容写作

审计代码与文档是否脱节

以只读方式比较实现和文档,找出过期、缺失或互相矛盾的说明。

进阶25 分钟更新于 2026-09-30
OUTCOME

先看最终成果

一份带证据位置和优先级的文档漂移报告。

STEP BY STEP

跟着步骤完成

  1. 01

    明确边界

    确定本次代码变更范围

  2. 02

    建立流程

    收集相关文档、示例和注释

  3. 03

    执行与留痕

    逐项比较声明与真实行为

  4. 04

    验证结果

    按用户影响排序修订建议

PROMPT

可直接使用的提示词

对{{功能或变更}}执行只读文档漂移审计。比较代码、README、配置说明、API 文档、示例和 changelog,报告准确/过期/缺失/冲突项,附双方位置和建议,不直接修改文件。

把双大括号中的内容替换为你的真实信息。先补足上下文,再追求表达效果。

QUALITY CHECK

交付前检查

  • 输入材料和任务边界已经明确
  • 关键判断能够回到真实证据
  • 高风险动作保留人工确认
  • 结果满足预先定义的验收标准
SOURCE

来源与改编说明

原始技能Docs Sync Audit
仓库
github/awesome-copilot
作者
GitHub 社区贡献者
许可证
MIT License
参考日期
2026-09-30

本站依据原技能的任务边界和工作流重新整理为中文实践教程,并非原项目官方译文。