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:
@@ -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
|
||||
```
|
||||
Reference in New Issue
Block a user