Index of every page on this site: llms.txt
All skills
tencent avatar

/tech-design

@5fadefc
by tencenttencent/loopforge5.2k stars
722
Run it yourself

通用技术方案撰写技能。根据需求输入(需求分析报告或口头描述)自动生成结构完整的技术方案 Markdown 文档。当用户说"帮我写技术方案"、"出一个技术设计文档"、"写一份 design doc"、"给这个需求出方案"时使用本技能。

Use this Skill: https://skilld.dev/gh/tencent/loopforge/tech-design

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

referencesgeneral.md

≈986 tokens on demand. Your agent reads this file only when SKILL.md points to it.

通用技术方案模板

方案结构

## 一、背景与目标

### 1.1 背景
[描述业务背景、当前存在的问题或痛点,以及为什么需要这个方案]

### 1.2 目标

**核心目标**:
- [目标1]
- [目标2]

**非目标(Out of Scope)**:
- [明确说明本方案不解决什么,避免范围蔓延]

### 1.3 名词解释

| 术语 | 含义 |
|------|------|
| XXX | ... |

---

## 二、现状分析

### 2.1 现有方案/流程
[描述当前的实现方式或业务流程,可用流程图辅助说明]

\`\`\`mermaid
flowchart LR
    A[现状] --> B[...]
\`\`\`

### 2.2 存在的问题

| 问题 | 影响 | 优先级 |
|------|------|--------|
| 问题1 | 影响描述 | 高/中/低 |

---

## 三、方案设计

### 3.1 方案概述
[用 2-3 句话描述整体方案思路]

### 3.2 方案对比(可选)

| 方案 | 优点 | 缺点 | 结论 |
|------|------|------|------|
| 方案A(推荐) | ... | ... | ✅ 采用 |
| 方案B | ... | ... | ❌ 放弃 |

**选择方案A的理由**:[说明决策依据]

### 3.3 详细设计

#### 3.3.1 整体流程

\`\`\`mermaid
flowchart TD
    A[开始] --> B[步骤1]
    B --> C{判断条件}
    C -->|是| D[处理A]
    C -->|否| E[处理B]
    D --> F[结束]
    E --> F
\`\`\`

#### 3.3.2 核心逻辑
[描述关键业务逻辑、算法或规则,必要时用伪代码或示例说明]

#### 3.3.3 数据结构/模型(如涉及)
[描述关键数据结构或模型设计]

#### 3.3.4 关键接口/协议(如涉及)
[描述关键接口定义或通信协议]

#### 3.3.5 第三方依赖(如涉及)

| 依赖项 | 用途 | 接入方式 |
|--------|------|---------|
| 系统/服务A | 用途描述 | API/SDK/消息队列 |

---

## 四、影响面分析

### 4.1 涉及模块/系统

| 模块/系统 | 变更类型 | 变更说明 |
|---------|---------|---------|
| 模块A | 新增/修改/删除 | 具体变更内容 |

### 4.2 兼容性

| 兼容性维度 | 结论 | 说明 |
|---------|------|------|
| 向前兼容 | 兼容/不兼容 | 说明 |
| 数据兼容 | 兼容/需迁移 | 说明 |

---

## 五、风险与应对

| 风险 | 概率 | 影响 | 应对措施 |
|------|------|------|---------|
| 风险1 | 高/中/低 | 高/中/低 | 具体措施 |

---

## 六、测试方案

| 测试类型 | 测试内容 | 通过标准 |
|---------|---------|---------|
| 功能测试 | 核心功能验证 | 所有用例通过 |
| 边界测试 | 异常输入/边界值 | 无异常崩溃 |
| 性能测试(如需) | 压测场景 | 满足性能目标 |

---

## 七、上线方案

### 7.1 上线步骤

1. [步骤1]
2. [步骤2]
3. [步骤3:验证]

### 7.2 回滚方案
[描述如果上线出现问题,如何快速回滚]

### 7.3 灰度策略(如需)
[描述灰度发布策略:按比例/按用户群/按地区等]

---

## 八、排期计划

| 阶段 | 内容 | 工期 | 负责人 |
|------|------|------|--------|
| 设计评审 | 方案确认 | X天 | 待定 |
| 开发 | 功能实现 | X天 | 待定 |
| 测试 | 功能/性能测试 | X天 | 待定 |
| 上线 | 灰度/全量 | X天 | 待定 |
| **合计** | | **X天** | |

---

## 九、遗留问题

| 问题 | 状态 | 负责人 | 截止时间 |
|------|------|--------|---------|
| 问题1 | 待讨论/已决策 | 待定 | - |

撰写要点

  • 先写结论:每个章节的核心结论放在最前面,细节放后面
  • 图文并茂:复杂流程优先用 Mermaid 图表达,文字辅助说明
  • 量化描述:目标、风险、影响尽量用数字量化,避免模糊表述
  • 明确决策:方案对比后必须明确说明选择理由,记录决策依据
  • Out of Scope:明确说明不在本方案范围内的内容,防止范围蔓延
  • 遗留问题:将未决事项显式记录,避免遗漏
  • 按需裁剪:不涉及的章节(如第三方依赖、灰度策略)可直接删除,不必强行填写

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No alerts1mo3 checks · Risk SAFE
  • Gen Agent Trust Hub1mo

    This skill automates the generation of technical design documents based on user-provided requirements. While functionally safe, it possesses a standard indirect prompt injection surface because it processes external files (requirement reports) without specific sanitization or boundary markers, which could allow malicious instructions within those files to influence the agent's output.

  • Socket1mo

    No alerts

  • Snyk1mo

    Risk: LOW · No issues

Signed by skilld at 5fadefc. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 18 hours ago.

Activeupdated last month

README badge

README badge for tencent/loopforge/tech-design