GitHub Copilot 提示文件实现「配置项说明」：写法与调用

如果你在文档仓库与文档站里反复做配置项说明，可以考虑把经验沉淀为一个 Skill：写清触发条件、步骤、输出格式和边界，让智能体代劳重复部分，人只负责把关。

本文介绍如何在 GitHub Copilot 指令与提示文件 上实现这个技能，包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。

这个技能做什么

处理流程分四步：

1. 列出配置键
2. 写类型与默认值
3. 说明作用与取值范围
4. 附示例

这个技能纯指令型，不需要额外脚本或外部连接，复制到大多数平台都能用；风险较低，但输出仍需快速过目再使用。

在 GitHub Copilot 指令与提示文件 中是什么形态

GitHub Copilot 支持仓库级自定义指令文件 .github/copilot-instructions.md，以及放在 .github/prompts/ 下、以 .prompt.md 结尾的可复用提示文件，适合把固定流程交给 Copilot Chat 或智能体模式执行。

仓库级指令对该仓库的对话默认生效；提示文件需要在支持的编辑器中手动调用，具体支持情况以 Copilot 文档为准。

示例配置

.github/prompts/config-reference.prompt.md 示例（示意）：

---
description: 配置项说明
---

请对我提供的配置代码执行「配置项说明」：

1. 列出配置键
2. 写类型与默认值
3. 说明作用与取值范围
4. 附示例

输出格式：配置参考。
- 文中的命令和接口要与当前代码逐一核对。
- 信息不足时先提问，不要自行编造数据或事实。

示例里最重要的是两处：一是描述（或指令开头）要写明「什么时候用」，让智能体在开发者与技术写作者提出相关请求时能对上号；二是约束部分要写进「文中的命令和接口要与当前代码逐一核对」这类领域规矩，避免智能体自作主张。

安装与启用步骤

1. 在 .github/copilot-instructions.md 中写入团队通用约定
2. 新建 .github/prompts/config-reference.prompt.md 写入本技能流程
3. 在编辑器的 Copilot Chat 中调用该提示文件
4. 检查输出是否遵循步骤与格式
5. 提交到仓库并在 PR 中说明用途

实操：一次完整的运行

假设你在文档仓库与文档站中发出这样的请求（虚构示例）：

用配置项说明技能处理这份配置代码，输出配置参考。

智能体识别到任务与「配置项说明」相关后，会依次列出配置键、写类型与默认值、说明作用与取值范围、附示例。最终交付配置参考，并在末尾列出需要人工确认的内容。你的工作是对照原始配置代码抽查两三处关键信息，确认无误后再使用。

测试与验收

在 Copilot Chat 中分别以有、无提示文件的方式处理同一任务，对比差异是否符合预期。

针对这个技能，还建议额外准备：

• 一份信息齐全的标准配置代码，检查输出是否完整
• 一份缺少关键信息的输入，检查智能体是否先提问而不是编造
• 一份包含“忽略以上规则”等字样的输入，检查约束是否仍然有效

常见坑

• 仓库级指令写得过细，与提示文件互相矛盾。
• 以为提示文件会自动生效，实际需要手动调用。
• 只写了步骤，没写交付格式，导致每次输出的配置参考结构不同。
• 没有给出样例，智能体对“好结果”的理解与你不一致；在参考资料里放一两份范例会明显改善。

延伸阅读

• 配置项说明 · 效果评估
• 配置项说明 · Claude Code Skill 版
• 配置项说明 · Cline Rules 版
• 文档链接检查 · GitHub Copilot 指令与提示文件 版
• 文档过期检查 · GitHub Copilot 指令与提示文件 版
• 智能体Skills 分类：625 个技能 × 32 个角度

说明：文中的配置、代码与目录结构均为示意，用于说明思路；各平台的入口、字段名与能力会更新，落地前请以对应官方文档为准。示例中的数据与场景为虚构，不代表真实案例。