3.0 KiB

Raw Blame History

变更日志: 文档目录结构整理

日期: 2026-02-02
类型: 重构

概述

根据 jointo-tech-stack 规范整理文档目录结构，将 docs/server/ 下的顶层文件移动到相应的子目录，确保文档组织符合项目规范。

变更内容

文档移动

移至 `docs/server/guides/`

AI_SERVICE_FLOW_DIAGRAM.md → ai-service-flow-diagram.md
AI_SERVICE_FLOW_MERMAID.md → ai-service-flow-mermaid.md
DEPLOYMENT.md → deployment.md
TEST_COVERAGE_AI_API.md → testing-ai-api.md

移至 `docs/server/changelogs/`

PROJECT_SERVICE_STATUS_2026-01-29.md → 2026-01-29-project-service-status.md

移至 `docs/.archive/server/`

LOGGING_MIGRATION_EXECUTION_SUMMARY.md → logging-migration-execution-summary.md
LOGGING_MIGRATION_FINAL_SUMMARY.md → logging-migration-final-summary.md
LOGGING_MIGRATION_PROGRESS.md → logging-migration-progress.md
LOGGING_MIGRATION_SUMMARY.md → logging-migration-summary.md

目录结构优化

整理前：

docs/server/
├── AI_SERVICE_FLOW_DIAGRAM.md
├── AI_SERVICE_FLOW_MERMAID.md
├── DEPLOYMENT.md
├── LOGGING_MIGRATION_*.md (4 个文件)
├── PROJECT_SERVICE_STATUS_2026-01-29.md
├── TEST_COVERAGE_AI_API.md
├── changelogs/
├── guides/
└── rfcs/

整理后：

docs/server/
├── changelogs/          # 166 个文件
├── guides/              # 15 个文件
└── rfcs/                # 42 个文件

规范符合性

✅ 符合规范

文档目录结构：
- docs/architecture/adrs/ - 架构决策记录
- docs/client/{rfcs,guides,changelogs} - 前端文档
- docs/server/{rfcs,guides,changelogs} - 后端文档
- docs/requirements/ - 需求文档
文件命名规范：
- Guides: 使用 kebab-case（如 ai-service-flow-diagram.md）
- Changelogs: 使用 YYYY-MM-DD-主题.md 格式
文档分类：
- 技术指南 → guides/
- 变更记录 → changelogs/
- 过时文档 → .archive/

📋 ADR 目录说明

根据项目规模，不创建 docs/client/adrs/ 和 docs/server/adrs/，所有架构决策统一记录在 docs/architecture/adrs/，理由：

当前项目规模下，跨模块架构决策占主导
避免文档分散，便于查找和维护
前端/后端特定的架构决策可在 RFC 中说明

影响

正面影响

✅ 文档组织更清晰，符合项目规范
✅ 便于查找和维护文档
✅ 新成员更容易理解文档结构
✅ 历史文档归档，减少主目录混乱

注意事项

如果有外部链接引用旧路径，需要更新链接
IDE 中打开的旧路径文件会失效，需重新打开

3.0 KiB Raw Blame History