工作指引详解

了解如何配置工作指引，包括快速操作等高级功能

工作指引详解

工作指引是工作空间的"说明书"，帮助团队成员和 AI 理解项目背景和工作要求。

什么是工作指引？

工作指引包含两部分内容：

  1. 配置区（YAML Front Matter）：快速操作等结构化配置
  2. 正文区（Markdown）：项目背景、规范说明等自由文本

AI 在处理您的请求时会参考这些信息，提供更符合项目需求的回答。

人机共读

工作指引不仅是给团队成员看的，也是给 AI 看的：

  • 团队成员：快速了解项目背景、工作流程和规范要求
  • AI 助手：作为 System Prompt 在每次新会话时自动传入，理解工作背景

如何编辑

  1. 点击左侧边栏顶部的 "工作指引" 菜单项
  2. 点击编辑按钮进入编辑模式
  3. 编写配置和正文内容
  4. 保存后立即生效

工作指引编辑界面

快速操作

快速操作（Quick Actions）是工作指引的高级功能，让您可以在工作空间首页配置常用操作的快捷入口。

功能说明

快速开始功能卡片

  • 在工作指引页面显示为卡片网格
  • 点击后自动打开 AI 对话栏并填充对应命令
  • 支持绑定快捷命令（QuickCommand），自动触发变量表单

配置格式

在工作指引顶部使用 YAML Front Matter 配置：

--- quickActions: - icon: "🚀" label: "初始化项目" description: "创建项目目录结构和基础配置" command: "初始化项目" - icon: "📋" label: "SOW需求分析" description: "分析需求文档，提取关键信息" command: "SOW需求分析" - icon: "📝" label: "创建文档" description: "创建新的知识库文档" command: "创建文档" - icon: "✅" label: "创建任务" description: "创建新的待办任务" command: "创建任务" --- # 项目背景 这里是 Markdown 正文内容...

字段说明

字段类型必填说明
iconstring是Emoji 图标，如 "🚀"、"📋"
labelstring是按钮显示文本，如 "初始化项目"
descriptionstring是操作说明，显示在标题下方
commandstring是绑定的命令名称，对应快捷命令的 name 字段

命令绑定机制

command 字段的值需要与工作空间中配置的快捷命令名称匹配：

  1. 系统会在快捷命令库中查找同名命令
  2. 如果找到匹配的命令，自动触发该命令（包括变量表单）
  3. 如果未找到，则将 command 值作为纯文本填充到输入框

使用建议

  • 建议配置 4-8 个快速操作，避免过多导致选择困难
  • 选择团队最常用的操作
  • 图标选择要有辨识度，避免重复
  • 描述文字简洁明了，控制在 20 字以内

正文内容

正文使用 Markdown 格式编写，推荐包含以下内容：

项目背景

## 项目背景 这是一个 B2B 电商平台的后台管理系统，主要用户是运营人员和管理员。 系统需要处理大量订单和商品数据，性能是重要考量。

技术栈

## 技术栈 - 前端：React 18 + TypeScript + Ant Design - 后端：Node.js + NestJS + PostgreSQL - 部署：Docker + Kubernetes

编码规范

## 编码规范 - 使用 TypeScript 严格模式 - 变量命名使用 camelCase - 组件命名使用 PascalCase - 提交信息使用中文，格式：类型(范围): 描述

术语定义

## 术语定义 - SKU：库存单位，商品的最小管理单元 - SPU：标准产品单位，商品的基本属性集合 - GMV：商品交易总额

完整示例

以下是一个完整的工作指引示例：

--- quickActions: - icon: "🚀" label: "开始新功能" description: "创建功能分支并初始化开发环境" command: "开始新功能" - icon: "🔍" label: "代码审查" description: "审查当前分支的代码变更" command: "代码审查" - icon: "📊" label: "生成周报" description: "汇总本周工作进展" command: "生成周报" - icon: "🐛" label: "问题排查" description: "分析并定位问题原因" command: "问题排查" --- # 电商后台管理系统 ## 项目背景 这是一个 B2B 电商平台的后台管理系统，主要用户是运营人员和管理员。 ## 技术栈 - 前端：React 18 + TypeScript + Ant Design - 后端：Node.js + NestJS + PostgreSQL ## 编码规范 - 使用 TypeScript 严格模式 - 提交信息使用中文 ## 注意事项 - 所有金额计算使用分为单位 - 敏感信息不能写入日志

最佳实践

1. 保持更新

工作指引应该随项目演进而更新：

  • 新技术引入时更新技术栈
  • 发现新约定时补充规范
  • 定期审查并删除过时内容

2. 具体而非抽象

使用具体的例子而非抽象的描述：

❌ 不好：使用良好的代码风格 ✅ 好： - 函数名使用动词开头：getUserById - 布尔变量使用 is/has 前缀：isActive, hasPermission

3. 适度详细

  • 关键信息要详细说明
  • 常识性内容可以省略
  • 复杂规则配以示例
  • 建议控制在 500-2000 字之间

常见问题

Q：快速操作最多可以配置多少个？

A：建议配置 4-8 个。虽然技术上没有限制，但过多会影响用户体验。

Q：command 必须是已存在的快捷命令吗？

A：不是必须的。如果 command 匹配到快捷命令，会触发完整的命令流程（包括变量表单）；如果没有匹配到，则作为纯文本填充到输入框。

Q：工作指引会影响 AI 的所有回复吗？

A：是的。工作指引会作为 System Prompt 的一部分，在每次新会话时传入 AI，影响整个会话的回复风格和内容。

相关文档

工作指引详解 | Knodo 文档