Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.devin.ai/llms.txt

Use this file to discover all available pages before exploring further.

不想手动设置？将本页链接粘贴到 Devin 会话中，让它为你完成所有设置。
1

让 Devin 为你生成指南

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

查看已生成的指南

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

## 1. Starting a Session
| Method | When to use | Example |
|--------|-------------|--------|
| **Slack** — message @Devin | Quick, scoped tasks | "Fix the failing CI in api-service" |
| **Web app** — app.devin.ai | Longer tasks needing file attachments or playbooks | Attach a migration playbook + spec file |

## 2. Writing Effective Prompts
Devin works best with specific, scoped requests. Always include
the file path, what's broken, and when it started.

❌ "Fix the login bug"
✅ "The login form at src/pages/Login.tsx returns a 401 for valid
   credentials since the JWT key rotation on Friday. Check the
   auth middleware at src/middleware/auth.ts."

## 3. Linear Integration
Go to Settings > Integrations > Linear and authorize. Once
connected, Devin can:
- Pick up tickets assigned to it automatically
- Update ticket status as it works
- Link PRs to the originating Linear ticket

See the full setup guide: docs.devin.ai/integrations/linear

## 4. Playbooks for Recurring Tasks
Create reusable prompts at Settings > Playbooks > Create New.
For our Express-to-Fastify migration, the playbook should include:
- The target module path (e.g., src/services/payments/)
- Test commands: npm run test:api && npm run test:integration
- Rollback steps if the migration breaks downstream consumers

## 5. Knowledge — Teaching Devin Our Conventions
Add team conventions at Settings > Knowledge > Add Knowledge.

Example entry:
  Trigger: "working on API routes"
  Content: "We use Fastify, not Express. All routes live in
  src/routes/. Run npm run test:api before committing.
  Error responses must use the ApiError class from src/lib/errors.ts."
3

通过后续提问扩展本指南

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

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

在你对这份指南满意后，将其分享出来，并将其保存为 Knowledge，这样 Devin 就可以参考你团队的约定：
  1. 分享这份指南 — 将 Notion 页面粘贴到你的 #engineering 频道，或将其在团队 wiki 中置顶
  2. 将其保存为 Knowledge — 前往 Settings > Knowledge > Add 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.”