feat: add frontend development guidelines and structure documentation
- Introduced API guidelines for interface contracts and request handling. - Added design tokens usage guidelines for consistent styling across the project. - Established DTO guidelines for defining request parameters and response data types. - Created frontend structure guidelines to clarify directory organization and code placement rules. - Compiled a comprehensive frontend development guideline document covering various aspects of the development process. - Implemented quality guidelines to ensure code maintainability and adherence to best practices.
This commit is contained in:
yuxuanhui
@@ -0,0 +1,66 @@
|
||||
---
|
||||
id: ARTIFACT-MODEL-AI-RD-WORKFLOW
|
||||
type: standard
|
||||
status: draft
|
||||
created: 2026-06-29
|
||||
---
|
||||
|
||||
# 产物模型
|
||||
|
||||
## 基本原则
|
||||
|
||||
每个需求产物都是一个可追踪 artifact。目录结构用于人工导航，frontmatter 用于机器读取和关联。
|
||||
|
||||
## 通用 frontmatter
|
||||
|
||||
```yaml
|
||||
---
|
||||
id: UR-20260629-001
|
||||
case_id: REQ-20260629-001
|
||||
type: user-requirement
|
||||
stage: user-requirement
|
||||
owner_role: PM
|
||||
status: draft
|
||||
source_ids:
|
||||
- INTAKE-20260629-001
|
||||
derived_ids:
|
||||
- RA-20260629-001
|
||||
- SA-20260629-001
|
||||
skill:
|
||||
name: pm-requirement-refine
|
||||
version: 0.1.0
|
||||
created: 2026-06-29
|
||||
updated: 2026-06-29
|
||||
---
|
||||
```
|
||||
|
||||
## 产物类型
|
||||
|
||||
| type | 阶段 | 负责人 | 主要输入 | 主要输出 |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| intake | 用户需求 | PM | 原始输入 | 需求背景、目标、问题陈述 |
|
||||
| user-requirement | 用户需求 | PM | intake | UR |
|
||||
| requirement-analysis | 用户需求 | PM | UR | RA |
|
||||
| scenario-analysis | 用户需求 | PM | UR / RA | SA |
|
||||
| objective-requirement | 研发需求 | SE | UR / RA / SA | OR |
|
||||
| development-requirement | 研发需求 | SE | OR | DR |
|
||||
| design-specification | 详细设计 | RD | OR / DR | DS |
|
||||
| implementation-task | 编码 | RD / AI | DS | 开发任务、变更集 |
|
||||
| test-plan | 测试 | QA / RD / AI | UR / OR / DR / DS | TP |
|
||||
| test-case | 测试 | QA / RD / AI | TP / DS | TC |
|
||||
|
||||
## 状态
|
||||
|
||||
- `draft`：草稿。
|
||||
- `reviewing`：评审中。
|
||||
- `approved`：已通过评审。
|
||||
- `rework`：需要返工。
|
||||
- `implemented`：已实现。
|
||||
- `verified`：已验证。
|
||||
- `archived`：已归档。
|
||||
|
||||
## 关联方向
|
||||
|
||||
- `source_ids`：当前产物直接依赖的上游产物。
|
||||
- `derived_ids`：由当前产物直接产出的下游产物。
|
||||
- `case_id`：将同一需求链路下的所有产物绑定到一个需求实例。
|
||||
@@ -0,0 +1,23 @@
|
||||
---
|
||||
id: GLOSSARY-AI-RD-WORKFLOW
|
||||
type: glossary
|
||||
status: draft
|
||||
created: 2026-06-29
|
||||
---
|
||||
|
||||
# 术语
|
||||
|
||||
| 缩写 | 名称 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| INTAKE | 原始输入 | 用户、业务方、运营、客户等给出的初始需求输入。 |
|
||||
| UR | User Requirement | 用户需求。描述用户目标、业务价值、范围和验收方向。 |
|
||||
| RA | Requirement Analysis | 需求分析。对用户需求进行澄清、拆解、约束识别和风险分析。 |
|
||||
| SA | Scenario Analysis | 场景分析。描述典型用户场景、异常场景、边界场景。 |
|
||||
| OR | Objective Requirement | 研发目标需求。由 SE 从业务目标转译为研发目标、范围、成功标准和约束。 |
|
||||
| DR | Development Requirement | 研发需求。描述功能、非功能、接口、数据、依赖、兼容性等工程要求。 |
|
||||
| DS | Design Specification | 详细设计。RD 基于 OR、DR 输出的可开发设计说明。 |
|
||||
| TP | Test Plan | 测试计划。描述测试范围、策略、环境和准入准出条件。 |
|
||||
| TC | Test Case | 测试用例。描述具体测试步骤、数据、预期结果和关联需求。 |
|
||||
| Traceability | 追踪关系 | 任一产物与上游输入、下游产物之间的可查关系。 |
|
||||
|
||||
> 这些缩写是本工作区的初始约定，可以在后续迭代中重命名，但要同步更新模板、skill 和示例 case。
|
||||
@@ -0,0 +1,65 @@
|
||||
---
|
||||
id: NAMING-CONVENTIONS-AI-RD-WORKFLOW
|
||||
type: standard
|
||||
status: draft
|
||||
created: 2026-06-29
|
||||
---
|
||||
|
||||
# 命名规范
|
||||
|
||||
## Case ID
|
||||
|
||||
格式：
|
||||
|
||||
```text
|
||||
REQ-yyyymmdd-nnn-short-name
|
||||
```
|
||||
|
||||
示例：
|
||||
|
||||
```text
|
||||
REQ-20260629-001-ai-rd-workflow
|
||||
```
|
||||
|
||||
## Artifact ID
|
||||
|
||||
格式：
|
||||
|
||||
```text
|
||||
<PREFIX>-yyyymmdd-nnn
|
||||
```
|
||||
|
||||
常用前缀：
|
||||
|
||||
- `INTAKE`
|
||||
- `UR`
|
||||
- `RA`
|
||||
- `SA`
|
||||
- `OR`
|
||||
- `DR`
|
||||
- `DS`
|
||||
- `TASK`
|
||||
- `TP`
|
||||
- `TC`
|
||||
|
||||
## 文件名
|
||||
|
||||
真实 case 中推荐使用：
|
||||
|
||||
```text
|
||||
<ARTIFACT-ID>-<short-name>.md
|
||||
```
|
||||
|
||||
示例：
|
||||
|
||||
```text
|
||||
UR-20260629-001-ai-rd-workflow.md
|
||||
```
|
||||
|
||||
模板文件使用语义名称：
|
||||
|
||||
```text
|
||||
user-requirement.md
|
||||
scenario-analysis.md
|
||||
design-specification.md
|
||||
```
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
id: ROADMAP-AI-RD-WORKFLOW
|
||||
type: roadmap
|
||||
status: draft
|
||||
created: 2026-06-29
|
||||
---
|
||||
|
||||
# 路线图
|
||||
|
||||
## M0：骨架期
|
||||
|
||||
- 建立目录结构、文档类型、ID 规则和追踪关系。
|
||||
- 创建第一批模板和 skill 草稿。
|
||||
- 用一个示例 case 跑通链路。
|
||||
|
||||
## M1：PM 需求侧
|
||||
|
||||
- 完善用户需求评审 skill。
|
||||
- 完善需求细化 skill。
|
||||
- 固化需求分析、场景分析、验收标准模板。
|
||||
|
||||
## M2：SE 研发需求侧
|
||||
|
||||
- 完善研发需求评审 skill。
|
||||
- 明确 OR、DR 的字段、质量标准和评审门禁。
|
||||
- 建立从 PM 产物到 SE 产物的追踪矩阵。
|
||||
|
||||
## M3：RD 详细设计侧
|
||||
|
||||
- 完善从 OR、DR 生成 DS 的 skill。
|
||||
- 将 DS 拆到可由 AI 执行的开发任务粒度。
|
||||
- 明确接口、数据、状态、异常、测试点的设计要求。
|
||||
|
||||
## M4：编码与测试闭环
|
||||
|
||||
- 建立 AI 编码任务模板。
|
||||
- 建立测试计划和测试用例生成 skill。
|
||||
- 建立变更影响分析和回归范围识别规则。
|
||||
|
||||
## M5：评测与持续优化
|
||||
|
||||
- 建立 skill eval case。
|
||||
- 记录 prompt run 与失败样本。
|
||||
- 通过复盘更新规范、模板和 skill。
|
||||
Reference in New Issue
Block a user