参考文档（Reference Documentation）¶

概述¶

此文件夹包含所有参考文档，包括管理方案、指南、流程等辅助文档。这些文档不涉及具体功能实现，而是指导开发流程和最佳实践。

文件夹结构¶

Text Only

03-reference/
├── DOCUMENTATION_MANAGEMENT_SUMMARY.md      # 文档管理总结
├── POPULAR_DOCUMENTATION_SOLUTIONS.md       # 流行文档管理方案对比
├── MKDOCS_SETUP_GUIDE.md                    # MkDocs 配置指南
├── DOCUMENTATION_SOLUTION_GUIDE.md          # 文档管理方案选择指南
└── README.md                                # 本文件说明

文档清单¶

DOCUMENTATION_MANAGEMENT_SUMMARY.md¶

版本: 1.0
最后更新: 2026-03-15
状态: ✅ 生效中
用途: 文档管理方案的总结
包含内容:
问题分析
解决方案
关键改进
下一步工作

何时使用: - 需要快速了解文档管理方案 - 需要了解为什么做出这些改变

POPULAR_DOCUMENTATION_SOLUTIONS.md¶

版本: 1.0
最后更新: 2026-03-15
状态: ✅ 生效中
用途: 流行的开发文档管理方案对比
包含内容:
10 种流行方案详细介绍
功能对比表
成本对比
推荐方案

何时使用: - 需要了解其他文档管理方案 - 需要评估是否迁移到其他方案 - 需要为项目选择合适的方案

MKDOCS_SETUP_GUIDE.md¶

版本: 1.0
最后更新: 2026-03-15
状态: ✅ 生效中
用途: MkDocs 配置和使用指南
包含内容:
MkDocs 介绍
安装步骤
项目结构
配置示例
常用命令
部署选项
最佳实践

何时使用: - 需要安装和配置 MkDocs - 需要了解 MkDocs 的功能 - 需要部署文档网站

DOCUMENTATION_SOLUTION_GUIDE.md¶

版本: 1.0
最后更新: 2026-03-15
状态: ✅ 生效中
用途: 文档管理方案选择指南
包含内容:
快速对比
按场景分类推荐
详细对比表
迁移路径
决策树
实施建议

何时使用: - 需要选择合适的文档管理方案 - 需要评估迁移成本 - 需要制定长期文档管理策略

快速导航¶

我应该选择哪个方案？¶

快速了解 → DOCUMENTATION_SOLUTION_GUIDE.md
详细对比 → POPULAR_DOCUMENTATION_SOLUTIONS.md
实施 MkDocs → MKDOCS_SETUP_GUIDE.md

我想了解当前方案¶

→ DOCUMENTATION_MANAGEMENT_SUMMARY.md

我想迁移到其他方案¶

查看 POPULAR_DOCUMENTATION_SOLUTIONS.md 了解各方案
查看 DOCUMENTATION_SOLUTION_GUIDE.md 中的迁移路径
根据选择的方案查看对应的配置指南

最后更新¶

📅 2026-03-15 👤 Claude