devdocs-insights

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

洞察收集

Insight Collection

收集来自 UI/UX 审查、文档调研、外部参考等来源的改进建议,经用户确认后转化为开发需求。
Collect improvement suggestions from sources such as UI/UX reviews, document research, and external references, and convert confirmed items into development requirements after user approval.

语言规则

Language Rules

  • 支持中英文提问
  • 统一中文回复
  • 使用中文生成文档
  • Supports Chinese and English questions
  • Uniformly replies in Chinese
  • Generates documents in Chinese

触发条件

Trigger Conditions

  • 用户完成 UI/UX 审查,有优化建议
  • 用户调研了文档/方案,发现可借鉴点
  • 用户发现外部参考(竞品、最佳实践)可借鉴
  • 用户有改进想法需要转化为需求
  • User completes UI/UX review and has optimization suggestions
  • User conducts document/scheme research and identifies reference points
  • User finds external references (competitors, best practices) worth referencing
  • User has improvement ideas that need to be converted into requirements

核心理念

Core Concepts

洞察来源

Insight Sources

┌─────────────────────────────────────────────────────────────┐
│                      洞察来源                                │
├─────────────────────────────────────────────────────────────┤
│  🎨 UI/UX 审查     │ 界面问题、交互优化、视觉改进            │
├─────────────────────────────────────────────────────────────┤
│  📄 文档调研       │ 技术方案、设计模式、架构参考            │
├─────────────────────────────────────────────────────────────┤
│  🔍 外部参考       │ 竞品分析、行业最佳实践、开源项目        │
├─────────────────────────────────────────────────────────────┤
│  💡 内部反馈       │ 用户反馈、团队建议、性能监控            │
└─────────────────────────────────────────────────────────────┘
┌─────────────────────────────────────────────────────────────┐
│                      Insight Sources                        │
├─────────────────────────────────────────────────────────────┤
│  🎨 UI/UX Review     │ Interface issues, interaction optimization, visual improvements            │
├─────────────────────────────────────────────────────────────┤
│  📄 Document Research       │ Technical solutions, design patterns, architecture references            │
├─────────────────────────────────────────────────────────────┤
│  🔍 External Reference       │ Competitor analysis, industry best practices, open source projects        │
├─────────────────────────────────────────────────────────────┤
│  💡 Internal Feedback       │ User feedback, team suggestions, performance monitoring            │
└─────────────────────────────────────────────────────────────┘

转化流程

Conversion Process

洞察来源                确认阶段                 输出阶段
    │                      │                        │
    ▼                      ▼                        ▼
┌─────────┐          ┌─────────┐            ┌─────────────┐
│ 收集    │    →     │ 用户    │      →     │ 追加到      │
│ 建议    │          │ 确认    │            │ 需求文档    │
└─────────┘          └─────────┘            └─────────────┘
                    部分确认 / 全部确认 / 拒绝
核心原则
  • 建议必须经过用户确认才能转化为需求
  • 保留建议来源的追溯性
  • 区分优先级,避免需求膨胀
Insight Sources                Confirmation Stage                 Output Stage
    │                      │                        │
    ▼                      ▼                        ▼
┌─────────┐          ┌─────────┐            ┌─────────────┐
│ Collect │    →     │ User    │      →     │ Append to    │
│ Suggestions │          │ Confirmation │            │ Requirements Doc │
└─────────┘          └─────────┘            └─────────────┘
                    Partial Confirmation / Full Confirmation / Reject
Core Principles:
  • Suggestions must be confirmed by users before conversion to requirements
  • Maintain traceability of suggestion sources
  • Prioritize suggestions to avoid requirement bloat

工作流程

Workflow

1. 识别洞察来源
2. 收集/整理建议
   ├── UI/UX 审查结果
   ├── 文档调研发现
   ├── 外部参考借鉴
   └── 内部反馈汇总
3. 结构化建议列表
   ├── 分类整理
   ├── 评估影响范围
   └── 建议优先级
4. 用户确认(AskUserQuestion)
   ├── 逐条确认
   ├── 批量确认
   └── 调整优先级
5. 转化为需求
   ├── 生成功能点 (F-XXX)
   ├── 生成验收标准 (AC-XXX)
   └── 追加到 01-requirements.md
6. 建议后续流程
   └── 运行 /devdocs-system-design 或 /devdocs-dev-tasks
1. Identify Insight Sources
2. Collect/Organize Suggestions
   ├── UI/UX Review Results
   ├── Document Research Findings
   ├── External Reference Insights
   └── Internal Feedback Summary
3. Structured Suggestion List
   ├── Categorize and Organize
   ├── Evaluate Impact Scope
   └── Prioritize Suggestions
4. User Confirmation (AskUserQuestion)
   ├── Confirm Item by Item
   ├── Batch Confirmation
   └── Adjust Priorities
5. Convert to Requirements
   ├── Generate Feature Points (F-XXX)
   ├── Generate Acceptance Criteria (AC-XXX)
   └── Append to 01-requirements.md
6. Post-Suggestion Process
   └── Run /devdocs-system-design or /devdocs-dev-tasks

输出文件

Output Files

洞察记录(可选)

Insight Records (Optional)

文件
docs/devdocs/05-insights.md
用于记录洞察来源和转化历史,便于追溯。
File:
docs/devdocs/05-insights.md
Used to record insight sources and conversion history for traceability.

需求追加

Requirement Append

确认的建议将追加到:
docs/devdocs/01-requirements.md
Confirmed suggestions will be appended to:
docs/devdocs/01-requirements.md

建议结构

Suggestion Structure

单条建议格式

Single Suggestion Format

markdown
undefined
markdown
undefined

INS-001: <建议标题>

INS-001: <Suggestion Title>

属性内容
来源🎨 UI/UX 审查 / 📄 文档调研 / 🔍 外部参考 / 💡 内部反馈
参考<来源链接或描述>
现状<当前问题或不足>
建议<改进建议>
影响范围<涉及模块/功能>
优先级P0 / P1 / P2
状态⏳ 待确认 / ✅ 已确认 / ❌ 已拒绝 / 🔄 已转化
预期收益
  • <收益1>
  • <收益2>
undefined
AttributeContent
Source🎨 UI/UX Review / 📄 Document Research / 🔍 External Reference / 💡 Internal Feedback
Reference<Source link or description>
Current Status<Current issue or deficiency>
Suggestion<Improvement suggestion>
Impact Scope<Involved modules/features>
PriorityP0 / P1 / P2
Status⏳ Pending / ✅ Confirmed / ❌ Rejected / 🔄 Converted
Expected Benefits:
  • <Benefit 1>
  • <Benefit 2>
undefined

建议列表格式

Suggestion List Format

markdown
undefined
markdown
undefined

洞察收集:<主题>

Insight Collection: <Topic>

收集时间:YYYY-MM-DD 来源类型:UI/UX 审查 / 文档调研 / 外部参考
Collection Time: YYYY-MM-DD Source Type: UI/UX Review / Document Research / External Reference

建议汇总

Suggestion Summary

编号标题来源优先级状态
INS-001<标题>🎨P1
INS-002<标题>📄P0
IDTitleSourcePriorityStatus
INS-001<Title>🎨P1
INS-002<Title>📄P0

详细建议

Detailed Suggestions

INS-001: <标题>

INS-001: <Title>

...

...

确认结果

Confirmation Results

  • INS-001: 已确认 → F-XXX
  • INS-002: 待确认
  • INS-003: 已拒绝(原因:...)
undefined
  • INS-001: Confirmed → F-XXX
  • INS-002: Pending
  • INS-003: Rejected (Reason: ...)
undefined

来源类型处理

Source Type Handling

🎨 UI/UX 审查

🎨 UI/UX Review

markdown
**输入**- 用户提供截图/原型
- 用户描述交互问题
- 运行 /ui-orchestrator 审查结果

**关注点**- 可用性问题
- 视觉一致性
- 无障碍性
- 响应式适配
- 交互流畅度

**示例建议**- INS-001: 按钮对比度不足,影响可读性
- INS-002: 表单缺少加载状态反馈
- INS-003: 移动端导航菜单难以点击
markdown
**Input**:
- Screenshots/prototypes provided by user
- User describes interaction issues
- Results from running /ui-orchestrator review

**Focus Areas**:
- Usability issues
- Visual consistency
- Accessibility
- Responsive adaptation
- Interaction fluency

**Example Suggestions**:
- INS-001: Insufficient button contrast affects readability
- INS-002: Form lacks loading state feedback
- INS-003: Mobile navigation menu is hard to click

📄 文档调研

📄 Document Research

markdown
**输入**- 技术文档链接
- 设计方案文档
- 最佳实践指南

**关注点**- 可借鉴的架构模式
- 更优的实现方案
- 性能优化技术
- 安全加固措施

**示例建议**- INS-004: 采用 React Query 替代手动状态管理
- INS-005: 引入乐观更新提升用户体验
- INS-006: 使用 Zod 进行运行时类型校验
markdown
**Input**:
- Technical document links
- Design scheme documents
- Best practice guides

**Focus Areas**:
- Referenceable architecture patterns
- Optimal implementation solutions
- Performance optimization techniques
- Security hardening measures

**Example Suggestions**:
- INS-004: Replace manual state management with React Query
- INS-005: Introduce optimistic updates to enhance user experience
- INS-006: Use Zod for runtime type validation

🔍 外部参考

🔍 External Reference

markdown
**输入**- 竞品链接/截图
- 开源项目参考
- 行业报告

**关注点**- 竞品优势功能
- 行业通用模式
- 用户期望对齐

**示例建议**- INS-007: 参考 Notion 的拖拽排序交互
- INS-008: 借鉴 Linear 的快捷键系统
- INS-009: 采用类似 Figma 的实时协作模式
markdown
**Input**:
- Competitor links/screenshots
- Open source project references
- Industry reports

**Focus Areas**:
- Competitor advantage features
- Industry common patterns
- Align with user expectations

**Example Suggestions**:
- INS-007: Reference Notion's drag-and-drop sorting interaction
- INS-008: Adopt Linear's shortcut key system
- INS-009: Implement real-time collaboration similar to Figma

💡 内部反馈

💡 Internal Feedback

markdown
**输入**- 用户反馈记录
- 团队讨论结果
- 性能监控数据

**关注点**- 高频用户痛点
- 团队共识问题
- 性能瓶颈

**示例建议**- INS-010: 列表加载慢,需要分页或虚拟滚动
- INS-011: 搜索功能缺少高级筛选
- INS-012: 导出功能需要支持更多格式
markdown
**Input**:
- User feedback records
- Team discussion results
- Performance monitoring data

**Focus Areas**:
- High-frequency user pain points
- Team consensus issues
- Performance bottlenecks

**Example Suggestions**:
- INS-010: List loading is slow, needs pagination or virtual scrolling
- INS-011: Search function lacks advanced filtering
- INS-012: Export function needs to support more formats

用户确认流程

User Confirmation Process

使用 AskUserQuestion 进行交互式确认:
Use AskUserQuestion for interactive confirmation:

单条确认

Single Item Confirmation

建议 INS-001: 按钮对比度不足,影响可读性

来源:🎨 UI/UX 审查
优先级:P1
影响范围:全局按钮组件

是否确认转化为需求?
- 确认(转化为 F-XXX)
- 调整优先级后确认
- 拒绝(请说明原因)
- 稍后决定
Suggestion INS-001: Insufficient button contrast affects readability

Source: 🎨 UI/UX Review
Priority: P1
Impact Scope: Global button components

Confirm conversion to requirement?
- Confirm (convert to F-XXX)
- Confirm after adjusting priority
- Reject (please explain reason)
- Decide later

批量确认

Batch Confirmation

以下建议待确认:

| 编号 | 标题 | 优先级 |
|------|------|--------|
| INS-001 | 按钮对比度不足 | P1 |
| INS-002 | 缺少加载状态 | P1 |
| INS-003 | 移动端导航问题 | P2 |

请选择:
- 全部确认
- 选择性确认(输入编号,如:1,2)
- 全部拒绝
- 逐条审查
The following suggestions are pending confirmation:

| ID | Title | Priority |
|------|------|--------|
| INS-001 | Insufficient button contrast | P1 |
| INS-002 | Missing loading state | P1 |
| INS-003 | Mobile navigation issues | P2 |

Please select:
- Confirm All
- Selective Confirmation (Enter IDs, e.g.: 1,2)
- Reject All
- Review Item by Item

需求转化规则

Requirement Conversion Rules

转化映射

Conversion Mapping

建议类型转化为说明
新功能建议F-XXX (新功能点)创建新的功能点
优化建议F-XXX (优化标记)标记为优化类型
Bug 修复直接触发 /devdocs-bugfix走 Bug 修复流程
技术改进F-XXX (技术债务)标记为技术改进
Suggestion TypeConvert toDescription
New Feature SuggestionF-XXX (New Feature)Create new feature item
Optimization SuggestionF-XXX (Optimization Tag)Mark as optimization type
Bug Fix SuggestionTrigger /devdocs-bugfix directlyFollow bug fix process
Technical ImprovementF-XXX (Technical Debt)Mark as technical improvement

功能点格式

Feature Point Format

markdown
undefined
markdown
undefined

F-XXX: <功能名称> [优化]

F-XXX: <Feature Name> [Optimization]

来源:INS-XXX (<来源类型>) 优先级:P0 / P1 / P2
描述: <从建议转化的功能描述>
验收标准
  • AC-XXX: <可验证的标准1>
  • AC-XXX: <可验证的标准2>
undefined
Source: INS-XXX (<Source Type>) Priority: P0 / P1 / P2
Description: <Feature description converted from suggestion>
Acceptance Criteria:
  • AC-XXX: <Verifiable Criterion 1>
  • AC-XXX: <Verifiable Criterion 2>
undefined

编号规则

Numbering Rules

  • 功能点编号:延续
    01-requirements.md
    中的编号
  • 验收标准编号:延续现有 AC 编号
  • 建议编号:INS-XXX(仅在洞察文档中使用)
  • Feature point numbering: Continue the numbering in
    01-requirements.md
  • Acceptance criteria numbering: Continue existing AC numbering
  • Suggestion numbering: INS-XXX (Only used in insight documents)

约束

Constraints

收集约束

Collection Constraints

  • 必须标明建议来源
  • 必须评估影响范围
  • 每条建议必须有明确的现状和改进点
  • 外部参考必须提供来源链接
  • Must indicate suggestion source
  • Must evaluate impact scope
  • Each suggestion must have clear current status and improvement points
  • External references must provide source links

确认约束

Confirmation Constraints

  • 所有建议必须经过用户确认才能转化
  • 拒绝的建议必须记录原因
  • 批量确认前必须展示完整列表
  • 用户可以调整建议优先级
  • All suggestions must be confirmed by users before conversion
  • Rejected suggestions must record reasons
  • Full list must be displayed before batch confirmation
  • Users can adjust suggestion priorities

转化约束

Conversion Constraints

  • 转化后的需求必须可追溯到原始建议
  • 必须生成可验证的验收标准
  • 优化类需求必须标记 [优化] 标签
  • 转化后更新建议状态为 🔄 已转化
  • Converted requirements must be traceable to original suggestions
  • Must generate verifiable acceptance criteria
  • Optimization requirements must be marked with [Optimization] tag
  • Update suggestion status to 🔄 Converted after conversion

避免需求膨胀

Avoid Requirement Bloat

  • 单次收集建议不超过 10 条
  • 低优先级建议可标记为"待定"
  • 鼓励用户聚焦核心改进
  • 定期清理过期的待确认建议
  • No more than 10 suggestions per collection
  • Low-priority suggestions can be marked as "Pending"
  • Encourage users to focus on core improvements
  • Regularly clean up expired pending suggestions

Skill 协作

Skill Collaboration

场景协作 Skill说明
UI/UX 审查来源
/ui-orchestrator
审查结果可作为洞察来源
需求转化
/devdocs-requirements
被调用:洞察转化为需求
设计变更
/devdocs-system-design
触发:复杂改进需要设计调整
测试补充
/devdocs-test-cases
触发:改进建议需要测试覆盖
简单改进
/devdocs-dev-tasks
无架构变更,直接拆分任务
复杂改进
/devdocs-feature
有架构变更,走完整流程
Bug 类建议
/devdocs-bugfix
走 Bug 修复流程
需求更新
/devdocs-sync
同步文档状态
ScenarioCollaborative SkillDescription
UI/UX Review Source
/ui-orchestrator
Review results can be used as insight sources
Requirement Conversion
/devdocs-requirements
Called: Convert insights to requirements
Design Changes
/devdocs-system-design
Triggered: Complex improvements require design adjustments
Test Supplement
/devdocs-test-cases
Triggered: Improvement suggestions need test coverage
Simple Improvements
/devdocs-dev-tasks
No architectural changes, directly split into tasks
Complex Improvements
/devdocs-feature
With architectural changes, follow full process
Bug-Type Suggestions
/devdocs-bugfix
Follow bug fix process
Requirement Updates
/devdocs-sync
Sync document status

使用示例

Usage Examples

示例一:UI/UX 审查后

Example 1: After UI/UX Review

用户: 我刚审查了登录页面,发现几个问题想优化

Agent: 好的,让我帮你收集这些优化建议。请描述发现的问题:

用户:
1. 密码输入框没有显示/隐藏切换
2. 忘记密码链接不够明显
3. 第三方登录按钮风格不统一

Agent: 已整理以下建议:

| 编号 | 标题 | 优先级 | 状态 |
|------|------|--------|------|
| INS-001 | 添加密码可见性切换 | P1 | ⏳ |
| INS-002 | 突出忘记密码链接 | P2 | ⏳ |
| INS-003 | 统一第三方登录按钮风格 | P2 | ⏳ |

请确认要转化为需求的建议(输入编号,如 1,2,3 或 "全部"):

用户: 1,3

Agent:
✅ 已确认 INS-001, INS-003
已追加到 01-requirements.md:
- F-015: 密码可见性切换 [优化] (来源: INS-001)
- F-016: 统一第三方登录按钮 [优化] (来源: INS-003)

是否继续运行 /devdocs-dev-tasks 拆分开发任务?
User: I just reviewed the login page and found several issues to optimize

Agent: Sure, let me help you collect these optimization suggestions. Please describe the issues you found:

User:
1. Password input box has no show/hide toggle
2. Forgot password link is not prominent enough
3. Third-party login button styles are inconsistent

Agent: The following suggestions have been organized:

| ID | Title | Priority | Status |
|------|------|--------|------|
| INS-001 | Add password visibility toggle | P1 | ⏳ |
| INS-002 | Highlight forgot password link | P2 | ⏳ |
| INS-003 | Unify third-party login button styles | P2 | ⏳ |

Please confirm the suggestions to convert to requirements (Enter IDs, e.g. 1,2,3 or "All"):

User: 1,3

Agent:
✅ Confirmed INS-001, INS-003
Appended to 01-requirements.md:
- F-015: Password Visibility Toggle [Optimization] (Source: INS-001)
- F-016: Unify Third-Party Login Buttons [Optimization] (Source: INS-003)

Would you like to continue running /devdocs-dev-tasks to split into development tasks?

示例二:文档调研后

Example 2: After Document Research

用户: 我看了这篇文章 https://example.com/react-patterns,想借鉴一些模式

Agent: 让我分析这篇文章并提取可借鉴的点...

[WebFetch 获取内容]

基于文章内容,整理以下借鉴建议:

| 编号 | 标题 | 参考章节 | 优先级 |
|------|------|----------|--------|
| INS-001 | 采用 Compound Components 模式 | 第3节 | P1 |
| INS-002 | 使用 Render Props 替代 HOC | 第5节 | P2 |
| INS-003 | 引入 Custom Hooks 复用逻辑 | 第7节 | P1 |

请确认要采纳的建议:
User: I read this article https://example.com/react-patterns and want to reference some patterns

Agent: Let me analyze this article and extract referenceable insights...

[WebFetch retrieves content]

Based on the article content, the following reference suggestions have been organized:

| ID | Title | Reference Section | Priority |
|------|------|----------|--------|
| INS-001 | Adopt Compound Components Pattern | Section 3 | P1 |
| INS-002 | Use Render Props instead of HOC | Section 5 | P2 |
| INS-003 | Introduce Custom Hooks for logic reuse | Section 7 | P1 |

Please confirm the suggestions you want to adopt:

命令选项

Command Options

bash
undefined
bash
undefined

标准模式:交互式收集和确认

Standard Mode: Interactive Collection and Confirmation

/devdocs-insights
/devdocs-insights

从 URL 提取建议

Extract Suggestions from URL

/devdocs-insights --url <url>
/devdocs-insights --url <url>

从文件提取(如审查报告)

Extract from File (e.g. review report)

/devdocs-insights --file <path>
/devdocs-insights --file <path>

快速模式:直接输入建议列表

Quick Mode: Directly input suggestion list

/devdocs-insights --quick
undefined
/devdocs-insights --quick
undefined

下一步

Next Steps

确认建议并转化为需求后,根据改进复杂度选择路径:
After confirming suggestions and converting to requirements, choose the path based on improvement complexity:

路径选择

Path Selection

确认的改进建议
评估是否涉及架构变更
      ├── 无架构变更(简单改进)
      │   ├── UI 微调、配置修改、小功能
      │   └── → /devdocs-dev-tasks 直接拆分任务
      └── 有架构变更(复杂改进)
          ├── 新接口、数据模型变更、新模块
          └── → /devdocs-feature 完整流程
                  └── system-design → test-cases → dev-tasks
Confirmed Improvement Suggestions
Evaluate if Architectural Changes are Involved
      ├── No Architectural Changes (Simple Improvements)
      │   ├── UI tweaks, configuration changes, small features
      │   └── → /devdocs-dev-tasks Directly split into tasks
      └── With Architectural Changes (Complex Improvements)
          ├── New APIs, data model changes, new modules
          └── → /devdocs-feature Full Process
                  └── system-design → test-cases → dev-tasks

架构变更判断

Architectural Change Judgment

条件是否架构变更推荐路径
仅 UI/样式调整
/devdocs-dev-tasks
仅配置项修改
/devdocs-dev-tasks
新增 API 接口
/devdocs-feature
数据模型变更
/devdocs-feature
新增独立模块
/devdocs-feature
第三方服务集成
/devdocs-feature
ConditionArchitectural Change?Recommended Path
Only UI/style adjustmentsNo
/devdocs-dev-tasks
Only configuration changesNo
/devdocs-dev-tasks
New API interface addedYes
/devdocs-feature
Data model changesYes
/devdocs-feature
New independent module addedYes
/devdocs-feature
Third-party service integrationYes
/devdocs-feature

使用 AskUserQuestion 确认

Confirmation with AskUserQuestion

已确认 X 条改进建议,转化为需求。

检测到以下情况:
- INS-001: UI 按钮样式调整 → 无架构变更
- INS-003: 新增导出 API → 涉及架构变更

建议路径:
- INS-001 → /devdocs-dev-tasks(直接拆分任务)
- INS-003 → /devdocs-feature(完整流程)

是否按建议执行?[是/调整]
X improvement suggestions have been confirmed and converted into requirements.

The following situations have been detected:
- INS-001: UI button style adjustment → No architectural changes
- INS-003: New export API added → Involves architectural changes

Recommended Paths:
- INS-001 → /devdocs-dev-tasks (Directly split into tasks)
- INS-003 → /devdocs-feature (Full process)

Execute as suggested? [Yes/Adjust]