56 lines
2.0 KiB
Markdown
56 lines
2.0 KiB
Markdown
|
# W5 单项目目录模板
|
|||
|
|
|
|||
|
|
> 来源：三端统一目录规范（README.md）2.5 节
|
|||
|
|
> 适用：一个目标、一个责任边界、有结束或冻结条件。该类直接承接 v1 规范。
|
|||
|
|
|
|||
|
|
## 结构
|
|||
|
|
|
|||
|
|
```text
|
|||
|
|
<project>/
|
|||
|
|
├── README.md # 项目卡片，必建
|
|||
|
|
├── .workspace.yaml # 类型登记，新建必建
|
|||
|
|
├── code/ # 仅代码型项目需要；内部为 Git 仓库
|
|||
|
|
│ ├── src/ # 主代码
|
|||
|
|
│ ├── tests/ # 测试
|
|||
|
|
│ └── README.md # 代码说明
|
|||
|
|
├── data/
|
|||
|
|
│ ├── raw/ # 原始数据
|
|||
|
|
│ ├── processed/ # 中间数据
|
|||
|
|
│ └── output/ # 数据输出
|
|||
|
|
├── report/ # 报告、图表、项目交付物
|
|||
|
|
├── research/ # 文献、调研、设计、实验记录
|
|||
|
|
├── scripts/ # 项目专用辅助脚本
|
|||
|
|
├── logs/ # 项目运行日志
|
|||
|
|
└── archive/ # 冻结旧产物
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 规则
|
|||
|
|
|
|||
|
|
- 除 README.md 外均按需创建，不建空目录
|
|||
|
|
- 项目卡片沿用 v1，补充：分类(W5)、权威路径、父工作区、备份策略、完成条件
|
|||
|
|
- 源码版本用 Git tag；archive/vN/ 只保存冻结交付物，不保存整套源码副本
|
|||
|
|
|
|||
|
|
## 项目卡片 README 模板
|
|||
|
|
|
|||
|
|
```markdown
|
|||
|
|
# <项目名>
|
|||
|
|
## 基本信息
|
|||
|
|
- 分类: W5
|
|||
|
|
- 域: 科研 | 写作 | 学习 | 运维 | 生活
|
|||
|
|
- 归属端: 服务器 | 本机 | 华为 | 多端（注明主要端）
|
|||
|
|
- 父工作区: <如有>
|
|||
|
|
- 关联 profile: （如 server/engineer…）
|
|||
|
|
- 关联服务: （如 llm-wiki :8083，无则 —）
|
|||
|
|
## 结构说明
|
|||
|
|
（本项目有哪些目录、各自放什么，2-3 行）
|
|||
|
|
## 数据与 git
|
|||
|
|
- 数据本体: <绝对路径>
|
|||
|
|
- git 远端: <地址或 —>
|
|||
|
|
- 版本 tag: <最新 tag 或 —>
|
|||
|
|
## 状态
|
|||
|
|
- 最后更新: <日期>
|
|||
|
|
- 完成条件: <何时可冻结/归档>
|
|||
|
|
- 备份策略: <备份方式或 —>
|
|||
|
|
- 备注: <运维提示/已知问题>
|
|||
|
|
```
|