Skip to main content
不想手动设置?将本页链接粘贴到 Devin 会话中,让它为你完成所有设置。
1

让 Devin 为你生成指南

Devin 通过 Devin Docs MCP 内置了对自身文档的访问能力——无需任何设置或配置。它可以按需搜索和阅读完整文档站点、API 参考、变更日志以及最佳实践。与其给新工程师发一长串文档链接,不如让 Devin 将你团队真正需要的内容提炼成一份统一的入职指南,其中包含针对你技术栈定制的提示词、工作流和示例。
2

查看已生成的指南

Devin 会针对每个主题搜索自身文档,阅读相关页面,并综合生成一份与您的技术栈和工作流程相匹配的完整上手指南。以下是输出结果示例:
# Devin 入门指南 — Acme 工程团队

## 1. 开始会话
| 方式 | 使用场景 | 示例 |
|--------|-------------|--------|
| **Slack** — 发消息给 @Devin | 快速、范围明确的任务 | "修复 api-service 中失败的 CI" |
| **Web 应用** — app.devin.ai | 需要附件或 Playbook 的较长任务 | 附上迁移 Playbook 和规范文件 |

## 2. 编写有效的提示词
Devin 在收到具体、范围明确的请求时效果最佳。请务必包含
文件路径、问题所在以及问题开始出现的时间。

❌ "修复登录 bug"
✅ "自周五 JWT 密钥轮换后,src/pages/Login.tsx 中的登录表单对有效
   凭据返回 401 错误。请检查 src/middleware/auth.ts 中的
   认证中间件。"

## 3. Linear 集成
前往 设置 > 连接 > Linear 并进行授权。连接后,
Devin 可以:
- 自动接取分配给它的工单
- 在处理过程中更新工单状态
- 将 PR 关联到原始 Linear 工单

查看完整设置指南:docs.devin.ai/integrations/linear

## 4. 用于重复任务的 Playbook
在 设置 > Playbooks > 新建 中创建可复用的提示词。
对于我们的 Express 到 Fastify 迁移,Playbook 应包含:
- 目标模块路径(例如 src/services/payments/)
- 测试命令:npm run test:api && npm run test:integration
- 若迁移导致下游消费者出现问题时的回滚步骤

## 5. 知识库 — 教导 Devin 我们的规范
在 设置 > 知识库 > 创建知识 中添加团队规范。

示例条目:
  触发词:"处理 API 路由时"
  内容:"我们使用 Fastify,而非 Express。所有路由位于
  src/routes/。提交前请运行 npm run test:api。
  错误响应必须使用 src/lib/errors.ts 中的 ApiError 类。"
3

通过后续提问扩展本指南

保持同一个会话处于打开状态 — Devin 会保留上下文,并且可以在此基础上为指南扩展更多章节。
4

分享本指南并保持其最新状态

在你对这份指南满意后,将其分享出来,并将其保存为 Knowledge,这样 Devin 就可以参考你团队的约定:
  1. 分享这份指南 — 将 Notion 页面粘贴到你的 #engineering 频道,或将其在团队 wiki 中置顶
  2. 将其保存为 Knowledge — 前往 Settings > Knowledge > Create knowledge,将触发条件设为 "onboarding new team members to Devin",粘贴指南内容,并将其置顶到 所有代码仓库 (all repositories)
现在,当任何团队成员问 Devin “how should I write prompts?” 或 “how do I connect Linear?” 时,它会从你自定义的指南中获取答案,而不是通用文档。随着 Devin 发布新功能,请让它按相同的对话格式更新这份指南:“Read the latest changelog and update our onboarding guide with any new features that affect our workflows.”