Skip to content

知识共享与 Prompt 库管理

一个人摸索出的好 Prompt,如果只藏在自己的对话历史里,对团队毫无价值。建立共享的 Prompt 库,能让整个团队站在彼此的肩膀上,避免重复踩坑,持续沉淀 AI 使用经验。

Prompt 库不是简单的"快捷方式收藏夹",而是团队 AI 使用知识的结构化载体,涵盖模板、使用说明、效果记录和版本历史。


一、为什么团队需要共享 Prompt 库

痛点Prompt 库的解决方式
每人重新发明轮子复用已验证的 Prompt 模板
效果参差不齐统一高质量的起点
好经验无法传承系统化沉淀和共享
新人上手慢直接使用团队积累的模板
难以衡量 AI 效果通过版本迭代追踪效果改进
AI 工具频繁更新集中更新模板,避免各自维护

二、Prompt 库的组织方式

方式一:按任务类型分类(推荐作为主分类)

team-prompts/
  ├── code-generation/       # 代码生成
  │   ├── crud-api.md
  │   ├── unit-test.md
  │   └── data-migration.md
  ├── code-review/           # 代码审查辅助
  │   ├── security-check.md
  │   └── performance-review.md
  ├── documentation/         # 文档生成
  │   ├── api-docs.md
  │   └── changelog.md
  ├── debugging/             # 排查问题
  │   ├── error-analysis.md
  │   └── performance-profiling.md
  └── architecture/          # 架构设计
      ├── system-design.md
      └── tech-selection.md

这种组织方式的优点是任务驱动:当开发者遇到具体任务时,能直觉性地找到对应目录。

方式二:按业务域分类

team-prompts/
  ├── frontend/
  ├── backend/
  ├── data-engineering/
  ├── devops/
  └── mobile/

适合业务差异大、各域技术栈差异显著的团队。

方式三:混合分类(适合大团队)

主目录按任务类型,子目录按业务域细分,兼顾通用性和专项需求。例如 code-generation/backend/django-crud.md


三、Prompt 模板格式标准

每个 Prompt 文件应遵循统一格式,便于查找、使用和维护:

markdown
---
title: 生成 RESTful CRUD API
category: code-generation
tags: [api, rest, express, fastapi]
tool: Claude / ChatGPT / Copilot Chat
author: 张三
created: 2024-03-01
updated: 2024-06-15
version: 1.2
---

# 生成 RESTful CRUD API

## 适用场景
需要快速生成标准的增删改查接口,适用于 Express.js 或 FastAPI 项目。

## Prompt 模板

你是一个后端工程师,使用 {框架名称}。 请为 {资源名称} 生成完整的 CRUD API,包含:

  1. 路由定义(GET/POST/PUT/DELETE)
  2. 输入验证(使用 {验证库})
  3. 错误处理(统一错误格式)
  4. 分页支持(GET 列表接口)
  5. 简单的 JSDoc 注释

数据模型:

注意事项:

  • 遵循 RESTful 命名规范
  • 错误响应格式:
  • 分页参数:page, pageSize,默认 page=1, pageSize=20

## 使用说明
将 `{}` 中的占位符替换为实际内容后使用。
框架名称示例:Express.js、FastAPI、Spring Boot

## 已知局限
- 生成的代码不包含数据库连接逻辑,需手动补充
- 复杂的业务规则需在生成后手动添加

## 变更历史
- v1.2 (2024-06-15):添加分页支持说明
- v1.1 (2024-04-10):增加错误格式要求
- v1.0 (2024-03-01):初版

四、版本管理策略

Prompt 和代码一样需要版本控制。推荐将 Prompt 库放在 Git 仓库中管理,获得完整的变更历史和协作能力。

版本号规则

主版本.次版本
  │     └── 小幅优化:措辞调整、补充说明、修复输出格式
  └── 结构性变化:适用范围改变、新增必填参数、输出格式重构

提交规范

bash
# 新增 Prompt
git commit -m "feat(prompts): 添加数据库 Schema 设计 Prompt"

# 优化已有 Prompt
git commit -m "improve(prompts): 优化单元测试模板,增加 Mock 说明"

# 修复无效 Prompt
git commit -m "fix(prompts): 修复 API 文档模板在 Claude 上输出格式错误"

# 废弃旧 Prompt
git commit -m "deprecate(prompts): 标记 OpenAI v3 格式 Prompt 为已废弃"

分支策略

对于重大 Prompt 改版(如因 AI 模型版本升级导致的大幅重写),建议通过 PR 方式提交,经过至少一名成员测试后合并,而不是直接推送到主分支。


五、共享平台与工具选型

方案对比

工具优点缺点适合场景
Git 仓库(Markdown)版本控制完整、开发者友好非技术成员使用门槛高纯开发团队
Notion / Confluence易于编辑和搜索无法 diff、协同冲突混合团队
内部 Wiki与现有文档融合搜索能力弱已有 Wiki 的团队
专用工具(PromptHub、Langfuse)功能丰富(A/B 测试、评分)需额外维护成本对 Prompt 质量要求高的团队

推荐搭配

小团队(< 10 人):Git 仓库 + Markdown,简单直接,零额外维护成本。

中型团队(10-50 人):Git 仓库作为 Source of Truth,Notion 作为可视化入口,自动同步或定期手动同步。

大型团队(> 50 人):专用 Prompt 管理平台 + CI/CD 集成验证。可考虑在 CI 中加入自动化测试,验证关键 Prompt 的输出是否仍满足预期格式。


六、质量维护机制

Prompt 库如果不维护,很快就会变成难以使用的垃圾堆。以下机制帮助保持库的质量。

使用反馈记录

在每个 Prompt 文件中维护使用反馈,让后来者了解真实效果:

markdown
## 使用反馈

| 日期 | 使用者 | 使用场景 | 效果评价 | 备注 |
|------|--------|----------|----------|------|
| 2024-11-20 | 李四 | FastAPI 项目 | 5/5 | 效果很好,直接可用 |
| 2024-09-15 | 王五 | Spring Boot | 3/5 | 需要调整错误处理部分 |

季度清理机制

每季度对 Prompt 库进行一次"大扫除":

  • 标记废弃:超过 6 个月未使用且没有近期反馈的 Prompt,标记 [DEPRECATED] 并移入 deprecated/ 目录
  • 合并重复:功能相似的 Prompt 合并为一个带参数的通用版本
  • 更新过时:针对工具新版本的特性(如新的上下文能力、格式支持)更新 Prompt 写法
  • 补充使用说明:对缺乏说明的历史条目补充适用场景和注意事项

贡献门槛控制

Prompt 库质量比数量更重要。建议设置贡献门槛:

  • 提交的 Prompt 须经过至少 2 次真实使用后再收录
  • 需包含至少一个真实输出示例(可脱敏处理)
  • 必须填写已知局限项,防止其他人踩坑

七、完整目录结构示例

以下是一个中等规模前后端团队的完整目录参考:

team-prompts/
  ├── README.md                    # 使用说明和贡献指南
  ├── TEMPLATE.md                  # Prompt 文件模板(复制后填写)

  ├── code-generation/
  │   ├── crud-api.md
  │   ├── unit-test-jest.md
  │   ├── unit-test-pytest.md
  │   ├── react-component.md
  │   ├── sql-query.md
  │   └── data-migration.md

  ├── code-review/
  │   ├── general-review.md
  │   ├── security-audit.md
  │   └── performance-check.md

  ├── documentation/
  │   ├── api-swagger.md
  │   ├── function-docstring.md
  │   └── pr-description.md

  ├── debugging/
  │   ├── error-root-cause.md
  │   ├── memory-leak.md
  │   └── slow-query.md

  ├── architecture/
  │   ├── system-design-review.md
  │   └── tech-selection.md

  └── deprecated/                  # 已废弃,保留备查
      └── old-openai-v3-prompts.md

八、快速启动:建立团队 Prompt 库的第一步

建立 Prompt 库不需要等到"准备好了"再开始。以下 6 步可以在一天内完成初始化:

  1. 创建仓库:在公司 GitLab/GitHub 创建 team-prompts 仓库,设置为内部可见
  2. 复制模板:将本文的格式规范作为 TEMPLATE.md 放入仓库根目录
  3. 收集存量:发起团队收集,鼓励每人贡献 2-3 个自己常用的 Prompt
  4. 整理分类:统一格式,建立目录结构,补充缺失的说明字段
  5. 推广使用:在团队会议上演示,选一个典型任务现场演示使用效果
  6. 建立节奏:确定季度清理和贡献激励机制,避免库逐渐失活

从 5 个高质量 Prompt 开始,比从 50 个粗糙条目开始更有价值。早期的 Prompt 库需要几个"明星模板"来建立团队信心,优先投入精力在最高频的任务类型上。