chore: 整理项目结构,清理归档文件,更新部署配置
This commit is contained in:
+24
-4
@@ -186,8 +186,28 @@ workbuddy 自动化开发,推送必须满足:
|
||||
|
||||
## 📚 关联文档
|
||||
|
||||
- [`README.md`](README.md) — 项目总览
|
||||
- [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) — 架构设计
|
||||
- [`docs/风险跟踪表.md`](docs/风险跟踪表.md) — 22 项审计追踪
|
||||
- [`docs/评审报告/`](docs/评审报告/) — workbuddy 推送评审
|
||||
- [`README.md`](README.md) — 项目总览(新人快速入门)
|
||||
- [`docs/01-项目总览与部署手册.md`](docs/01-项目总览与部署手册.md) — 完整架构设计与部署详情
|
||||
- [`docs/智能IT服务系统运维手册.md`](docs/智能IT服务系统运维手册.md) — 统一运维手册
|
||||
- [`docs/索引.md`](docs/索引.md) — 文档目录索引(快速导航)
|
||||
- [`CHANGELOG.md`](CHANGELOG.md) — 版本变更概览
|
||||
- [`docs/archive-归档/`](docs/archive-归档/) — 历史版本详情
|
||||
- [`.workbuddy/memory/`](.workbuddy/memory/) — workbuddy 任务记忆
|
||||
|
||||
---
|
||||
|
||||
## 📑 文档同步规则
|
||||
|
||||
**更新文档时需同步关联文档**:
|
||||
|
||||
| 更新内容 | 需同步的文档 |
|
||||
|---------|-------------|
|
||||
| 新功能/重构 | README.md(进度)+ CHANGELOG.md + 相关 docs/*.md |
|
||||
| 部署变更 | 智能IT服务系统运维手册.md + 01-项目总览与部署手册.md |
|
||||
| 安全修复 | CHANGELOG.md(Security 章节)+ 评审报告 |
|
||||
| API 变更 | README.md(API 概览)+ 01-项目总览与部署手册.md |
|
||||
|
||||
**文档目录规范**:
|
||||
- `docs/` 目录下按类型分子目录(deploy/, SOPs/, ADRs/, 评审报告/, archive/ 等)
|
||||
- 根目录保留 README.md / CONTRIBUTING.md / CHANGELOG.md(Git 生态标准)
|
||||
- 新增文档优先放在 `docs/`,避免根目录文件膨胀
|
||||
|
||||
Reference in New Issue
Block a user