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:
+39
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: DR-20260629-001
|
||||
case_id: REQ-20260629-001-example
|
||||
type: development-requirement
|
||||
stage: development-requirement
|
||||
owner_role: SE
|
||||
status: draft
|
||||
source_ids:
|
||||
- OR-20260629-001
|
||||
derived_ids:
|
||||
- DS-20260629-001
|
||||
created: 2026-06-29
|
||||
updated: 2026-06-29
|
||||
---
|
||||
|
||||
# DR:研发需求
|
||||
|
||||
## 功能需求
|
||||
|
||||
- 创建长期研究目录。
|
||||
- 创建标准文档。
|
||||
- 创建模板文档。
|
||||
- 创建 skill 草稿。
|
||||
- 创建示例 case。
|
||||
|
||||
## 非功能需求
|
||||
|
||||
- 文档应便于 Obsidian 浏览。
|
||||
- 结构应支持长期迭代。
|
||||
- skill 草稿应尽量接近 Codex skill 格式。
|
||||
|
||||
## 数据需求
|
||||
|
||||
- 每个 artifact 使用 frontmatter 维护追踪字段。
|
||||
|
||||
## 兼容性
|
||||
|
||||
- 不破坏 `AI Coding` 现有目录。
|
||||
- 不要求立即安装到 Codex skill 目录。
|
||||
+40
@@ -0,0 +1,40 @@
|
||||
---
|
||||
id: OR-20260629-001
|
||||
case_id: REQ-20260629-001-example
|
||||
type: objective-requirement
|
||||
stage: development-requirement
|
||||
owner_role: SE
|
||||
status: draft
|
||||
source_ids:
|
||||
- RA-20260629-001
|
||||
- SA-20260629-001
|
||||
derived_ids:
|
||||
- DR-20260629-001
|
||||
created: 2026-06-29
|
||||
updated: 2026-06-29
|
||||
---
|
||||
|
||||
# OR:研发目标需求
|
||||
|
||||
## 工程目标
|
||||
|
||||
在 vault 中建立一个可长期演化的 AI 研发工作流知识区,并支持需求链路追踪。
|
||||
|
||||
## 交付范围
|
||||
|
||||
- 目录结构。
|
||||
- 元模型规范。
|
||||
- 生命周期和追踪规范。
|
||||
- 模板。
|
||||
- skill 草稿。
|
||||
- 示例 case。
|
||||
|
||||
## 成功标准
|
||||
|
||||
- 所有核心目录存在。
|
||||
- 核心文档可被用户继续编辑。
|
||||
- 示例 case 能表达从 INTAKE 到 TC 的链路。
|
||||
|
||||
## 风险
|
||||
|
||||
- 当前 OR/DR/DS 定义是初始约定,后续可能按用户习惯调整。
|
||||
Reference in New Issue
Block a user