You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
26 lines
600 B
26 lines
600 B
4 months ago
|
# 项目文档目录
|
||
|
|
|
||
|
|
此目录用于存放项目相关的文档和计划文件。
|
||
|
|
|
||
|
|
## 目录结构
|
||
|
|
|
||
|
|
```
|
||
|
|
docs/
|
||
|
|
├── README.md # 本文件，目录说明
|
||
|
|
├── plans/ # 计划文件目录
|
||
|
|
│ └── *.plan.md # 项目计划文件
|
||
|
|
└── ... # 其他文档
|
||
|
|
```
|
||
|
|
|
||
|
|
## 使用说明
|
||
|
|
|
||
|
|
- **plans/** - 存放所有 `.plan.md` 计划文件
|
||
|
|
- 其他文档可以直接放在 `docs/` 根目录下
|
||
|
|
|
||
|
|
## 注意事项
|
||
|
|
|
||
|
|
- 计划文件建议使用 `.plan.md` 后缀
|
||
|
|
- 文档文件建议使用清晰的命名规范
|
||
|
|
- 重要文档建议在项目 README 中引用
|
||
|
|
|