Group Tech Design

Team Tech Design — Technical Design Document Generator (Team)

Help the user write a structured technical design document following a standard template, then save it to the team's Yuque knowledge base for group review.

When to Use

• User wants to write a technical design document or RFC and save it to the group repo
• User says "帮我写技术方案到团队库", "write a tech design for the team", "团队技术方案"
• User describes a feature/system and needs it formalized into a design doc for group review

Required MCP Tools

All tools are from the yuque-mcp server:

• yuque_search — (Optional) Search for related existing docs for context
• yuque_list_repos — Find the target group knowledge base
• yuque_create_doc — Create the design document

Reference

The full template is in references/template.md. Load it when generating the document.

Workflow

Step 1: Understand the Requirements

Gather from the user:

If the user provides a brief description, ask clarifying questions:

• "这个功能要解决什么问题？"
• "有什么技术约束吗？比如必须用某个框架、要兼容现有系统？"
• "预期的时间节点是什么？"

If the user hasn't specified a group login, ask: "请告诉我团队的语雀团队标识（group login），我来把技术方案存到团队知识库。"

Step 2: (Optional) Search for Context

If relevant, search Yuque for related existing documents:

Tool: yuque_search
Parameters:
  query: "<related keywords>"
  type: "doc"

This helps:

• Avoid duplicating existing designs
• Reference prior decisions
• Understand the current architecture

Step 3: Generate the Design Document

Load the template from references/template.md and fill in each section based on the user's input and your technical analysis.

Key sections to fill:

1. 背景 (Background) — Problem statement, current situation 2. 目标 (Goals) — What this design achieves, non-goals 3. 方案设计 (Design) — The core technical approach

• Architecture diagram description (describe in text/ASCII if needed)
• Core components and their responsibilities
• Data model / API design
• Key flows (sequence of operations)

4. 技术选型 (Tech Stack) — Why specific technologies were chosen 5. 方案对比 (Alternatives) — Other approaches considered and why they were rejected 6. 排期 (Timeline) — Milestones and estimated effort 7. 风险评估 (Risks) — What could go wrong and mitigation strategies 8. 参考资料 (References) — Related docs, links, prior art

Step 4: Review with User

Present the draft to the user before saving. Ask:

• "方案内容是否准确？有需要调整的地方吗？"
• "要补充其他技术细节吗？"

Step 5: Save to Team Yuque

Tool: yuque_list_repos
Parameters:
  login: "<group_login>"
  type: "group"

Find or ask for the target group repo (often "技术方案" or "设计文档" or "RFC").

Tool: yuque_create_doc
Parameters:
  repo_id: "<namespace>"    # e.g., "my-team/tech-docs"
  title: "[技术方案] <项目名称>"
  body: "<formatted design document>"
  format: "markdown"

Step 6: Confirm

✅ 技术方案已创建（草稿状态）！

📄 **[[技术方案] 项目名称](文档链接)**
📚 已保存到：「团队知识库名称」

### 文档结构
- 背景与目标
- 方案设计（含 X 个核心模块）
- 技术选型对比
- 排期（预计 X 周）
- 风险评估（X 个风险点）

💡 文档为草稿状态，请团队评审后发布。

Guidelines

• Write the design doc in Chinese (default) unless the user specifies English
• Be specific in the design section — include data models, API signatures, flow descriptions
• For tech stack comparison, use a table with pros/cons
• Keep the document actionable — someone should be able to implement from this doc
• If the user's requirements are vague, make reasonable assumptions and note them clearly with "【假设】" markers
• Don't over-engineer — match the design complexity to the project scope
• Always end the confirmation with "请团队评审后发布" — group designs need review
• This skill saves to group repos — for personal repos, use personal-tech-design

Error Handling

技术方案模板

使用说明：根据实际项目填写以下各节。标记为 [必填] 的部分必须完成，[可选] 部分根据项目复杂度决定是否需要。

---

[技术方案] {项目/功能名称}

---

1. 背景 [必填]

1.1 问题描述

[当前遇到了什么问题？为什么需要这个方案？]

1.2 现状分析

[目前的系统/流程是怎样的？有什么不足？]

---

2. 目标 [必填]

2.1 核心目标

• [目标 1]
• [目标 2]
• [目标 3]

2.2 非目标（Not Goals）

• [明确不在本次范围内的事项]

2.3 成功指标

---

3. 方案设计 [必填]

3.1 整体架构

[架构图描述或 ASCII 图]

┌──────────┐     ┌──────────┐     ┌──────────┐
│  Client  │────▶│  Server  │────▶│    DB    │
└──────────┘     └──────────┘     └──────────┘

3.2 核心模块

模块 1：{名称}

• 职责：[做什么]
• 输入：[接收什么]
• 输出：[产出什么]
• 关键逻辑：[核心处理流程]

模块 2：{名称}

• 职责：[做什么]
• 输入：[接收什么]
• 输出：[产出什么]

3.3 数据模型

CREATE TABLE example (
    id BIGINT PRIMARY KEY,
    name VARCHAR(255) NOT NULL,
    created_at TIMESTAMP DEFAULT NOW()
);

3.4 接口设计

API 1：{接口名称}

• Method: POST
• Path: /api/v1/example
• Request Body:

{
  "name": "string",
  "type": "string"
}

• Response:

{
  "code": 0,
  "data": { "id": 1 }
}

3.5 核心流程

[描述关键业务流程的步骤]

1. 用户发起请求 2. 服务端校验参数 3. 执行核心逻辑 4. 返回结果

---

4. 技术选型 [必填]

---

5. 方案对比 [可选]

结论：推荐方案 A，因为 [理由]。

---

6. 排期 [必填]

总计：预计 X 周完成。

---

7. 风险评估 [必填]

---

8. 参考资料 [可选]

• 相关文档 1
• 相关文档 2
• 外部参考