documentation

文档

概述

此技能提供 Documentation agent 使用的共享文档能力。 它将 audit、drift、validate 和 author 工作流所需的持久知识集中在一个 软件包中，让轻量封装能够加载特定模式的指导，而不必在行内嵌入 能力说明。

模式映射

Documentation agent 应根据模式加载相关技能章节：

模式	主要加载目标	备注
audit	references/conventions.md、references/coverage-method.md、references/validation-toolchain.md、references/content-sensitivity.md	以技能驱动的审计循环取代先前的 Doc Ops 工作流。
drift	references/conventions.md、references/code-doc-mapping.md、references/content-sensitivity.md	使用仓库本地映射表和漂移启发式方法。
validate	references/validation-toolchain.md、references/accessibility-checks.md、references/content-sensitivity.md、references/rai-guardrails.md	执行文档验证，并在需要时升级至正式审查。
author	templates/guide.md、templates/reference.md、references/conventions.md、references/accessibility-checks.md、references/content-sensitivity.md、references/rai-guardrails.md	按照仓库中记录的约定编写叙述性文档或参考文档。

成功标准

对于 audit 和 validate 模式，记录所有适用的本地安全检查结果，并单独记录现有 CI 状态。对于每项未运行且由 CI 负责的检查，将其标记为 Pending CI、Skipped、Deferred 或 Unavailable；不得报告为 Passed。

非目标

此技能不会编写 ADR、BRD、PRD 或其他规划文档。 它也不会在行内嵌入无障碍、RAI 或安全标准逻辑； 而是指向专用参考文件，并在场景需要时将正式评估交由 相应的规划人员处理。

工作约定

• 优先采用现有的仓库说明和脚本，而不是重复编写说明。
• 在 audit 和 validate 模式下，默认运行本地安全检查，并单独概述现有 CI 状态。只有在任务明确要求复现指定的 CI 检查通道时，才在本地执行由 CI 负责的检查通道。
• 将浏览器安装、模型或审核环境、服务、凭据和交互式 UI 视为单独的前置条件，而不是自动进行故障恢复。
• 文档变更应以事实为依据，并限定在当前任务范围内。
• 使用以下参考文件了解特定模式的方法、启发式方法和检查清单。
• 如果工作需要专家评估，则升级至规划人员，以进行正式的无障碍、RAI 或安全审查。

停止规则

对于 audit 和 validate 模式，在记录本地安全检查结果及任何单独的 CI 证据后停止。单独报告缺失的专用设置或必需的 CI 证据；不得推断、自动配置或报告为通过。

会话跟踪

按照标准会话文件约定，将会话状态写入 .copilot-tracking/documentation/， 并为本次运行使用 {{YYYY-MM-DD}}-session.md 文件。

参考文件

• references/conventions.md — 汇总仓库的 Markdown、写作风格和 Docusaurus 规范。
• references/code-doc-mapping.md — 代码与文档映射表及偏差判断规则。
• references/coverage-method.md — 审计模式下的缺口和覆盖率分析方法。
• references/validation-toolchain.md — 验证命令目录及结果解读。
• references/accessibility-checks.md — 内联文档检查和交接触发条件。
• references/content-sensitivity.md — 发布前的个人身份信息、密钥、保密性和 AI 披露检查。
• references/rai-guardrails.md — 注入边界、归属标注、人工审核和免责声明指南。

模板

• templates/guide.md — 叙述性指南和操作说明页面的结构模板。
• templates/reference.md — 参考文档和 API 风格文档的结构模板。