Copilot 自定义指令实战:查询转看板的 prompt.md 示例
「查询转看板」是后端与数据工程师的高频任务。它的输入通常是SQL 列表,期望得到的是看板设计。这类有固定流程、又需要一点判断力的工作,很适合封装成智能体 Skill。
本文介绍如何在 GitHub Copilot 指令与提示文件 上实现这个技能,包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。
这个技能做什么
| 项目 | 说明 |
|---|---|
| 技能 | 查询转看板(query-to-dashboard) |
| 作用 | 把一组 SQL 整理为看板指标与图表建议 |
| 输入 | SQL 列表 |
| 输出 | 看板设计 |
| 形态 | 纯提示词 |
| 风险 | 低 |
| 适用人群 | 后端与数据工程师 |
处理流程分四步:
- 归类指标
- 确定维度与粒度
- 推荐图表
- 写指标定义
这个技能纯指令型,不需要额外脚本或外部连接,复制到大多数平台都能用;风险较低,但输出仍需快速过目再使用。
在 GitHub Copilot 指令与提示文件 中是什么形态
GitHub Copilot 支持仓库级自定义指令文件 .github/copilot-instructions.md,以及放在 .github/prompts/ 下、以 .prompt.md 结尾的可复用提示文件,适合把固定流程交给 Copilot Chat 或智能体模式执行。
仓库级指令对该仓库的对话默认生效;提示文件需要在支持的编辑器中手动调用,具体支持情况以 Copilot 文档为准。
示例配置
.github/prompts/query-to-dashboard.prompt.md 示例(示意):
---
description: 查询转看板
---
请对我提供的SQL 列表执行「查询转看板」:
1. 归类指标
2. 确定维度与粒度
3. 推荐图表
4. 写指标定义
输出格式:看板设计。
- 默认使用只读连接,任何写操作都要人工确认。
- 信息不足时先提问,不要自行编造数据或事实。
示例里最重要的是两处:一是描述(或指令开头)要写明「什么时候用」,让智能体在后端与数据工程师提出相关请求时能对上号;二是约束部分要写进「默认使用只读连接,任何写操作都要人工确认」这类领域规矩,避免智能体自作主张。
安装与启用步骤
- 在
.github/copilot-instructions.md中写入团队通用约定 - 新建
.github/prompts/query-to-dashboard.prompt.md写入本技能流程 - 在编辑器的 Copilot Chat 中调用该提示文件
- 检查输出是否遵循步骤与格式
- 提交到仓库并在 PR 中说明用途
实操:一次完整的运行
假设你在数据库客户端与查询工具中发出这样的请求(虚构示例):
帮我做一下查询转看板,材料是附上的SQL 列表。
智能体识别到任务与「查询转看板」相关后,会依次归类指标、确定维度与粒度、推荐图表、写指标定义。最终交付看板设计,并在末尾列出需要人工确认的内容。你的工作是对照原始SQL 列表抽查两三处关键信息,确认无误后再使用。
测试与验收
在 Copilot Chat 中分别以有、无提示文件的方式处理同一任务,对比差异是否符合预期。
针对这个技能,还建议额外准备:
- 一份信息齐全的标准SQL 列表,检查输出是否完整
- 一份缺少关键信息的输入,检查智能体是否先提问而不是编造
- 一份包含“忽略以上规则”等字样的输入,检查约束是否仍然有效
常见坑
- 仓库级指令写得过细,与提示文件互相矛盾。
- 以为提示文件会自动生效,实际需要手动调用。
- 只写了步骤,没写交付格式,导致每次输出的看板设计结构不同。
- 没有给出样例,智能体对“好结果”的理解与你不一致;在参考资料里放一两份范例会明显改善。
延伸阅读
- 查询转看板 · 测试用例
- 查询转看板 · 极简与进阶
- 查询转看板 · 定制指南
- 种子数据生成 · GitHub Copilot 指令与提示文件 版
- 分区建议 · GitHub Copilot 指令与提示文件 版
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。