storage-function-structure

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

File Structure for Project Planning Artifacts

项目规划工件的文件结构

[Planning Artifact] are stored in dedicated directories based on their type, with each file named using a short hash and a descriptive title.
These directories are typically stored in a parent folder. defer to the storage backend conventions for exact paths.

[规划工件]根据其类型存储在专用目录中，每个文件使用短哈希和描述性标题命名。
这些目录通常存储在父文件夹中，具体路径遵循存储后端的约定。

Directory and File Naming Conventions

目录和文件命名约定

Each planning artifact type has its own directory:
- ```
Prd/
```
  for Product Requirements Documents
- ```
Epic/
```
  for Epics
- ```
Spec/
```
  for Specifications
- ```
Story/
```
  for User Stories
- ```
Task/
```
  for Tasks
- ```
Decision/
```
  for Decisions
- ```
Research/
```
  for Research Documents
- ```
Retro/
```
  for Retrospectives
Files within these directories are named using the format:
- ```
<short-hash>-<descriptive-title>.md
```

Prd/
  feca343-the-prd-title.md
Epic/
  123e4567-an-epic-title.md
Spec/
  89ab0123-a-spec-title.md
Story/
  456def78-a-story-title.md
  321cba98-another-story-title.md
  334fed56-yet-another-story-title.md
Task/
  789abc12-a-task-title.md
  654ghi34-another-task-title.md
  987jkl56-yet-another-task-title.md
Decision/
  112mno78-a-decision-title.md
  223pqr90-another-decision-title.md
  334stu12-yet-another-decision-title.md
  fff44455-a-fourth-decision-title.md
Ressearch/
  445vwx34-a-research-title.md
  556yzb56-another-research-title.md
  667abc78-yet-another-research-title.md
  778def90-a-fourth-research-title.md
Retro/
  889ghi12-a-retro-title.md
  990jkl34-another-retro-title.md
  aabmno56-yet-another-retro-title.md
  bbcpqr78-a-fourth-retro-title.md
  ccdstu90-a-fifth-retro-title.md

每种规划工件类型都有其专属目录：
- ```
Prd/
```
  用于存储产品需求文档
- ```
Epic/
```
  用于存储史诗
- ```
Spec/
```
  用于存储规范说明
- ```
Story/
```
  用于存储用户故事
- ```
Task/
```
  用于存储任务
- ```
Decision/
```
  用于存储决策记录
- ```
Research/
```
  用于存储调研文档
- ```
Retro/
```
  用于存储复盘报告
这些目录中的文件命名遵循以下格式：
- ```
<short-hash>-<descriptive-title>.md
```

Prd/
  feca343-the-prd-title.md
Epic/
  123e4567-an-epic-title.md
Spec/
  89ab0123-a-spec-title.md
Story/
  456def78-a-story-title.md
  321cba98-another-story-title.md
  334fed56-yet-another-story-title.md
Task/
  789abc12-a-task-title.md
  654ghi34-another-task-title.md
  987jkl56-yet-another-task-title.md
Decision/
  112mno78-a-decision-title.md
  223pqr90-another-decision-title.md
  334stu12-yet-another-decision-title.md
  fff44455-a-fourth-decision-title.md
Ressearch/
  445vwx34-a-research-title.md
  556yzb56-another-research-title.md
  667abc78-yet-another-research-title.md
  778def90-a-fourth-research-title.md
Retro/
  889ghi12-a-retro-title.md
  990jkl34-another-retro-title.md
  aabmno56-yet-another-retro-title.md
  bbcpqr78-a-fourth-retro-title.md
  ccdstu90-a-fifth-retro-title.md