文档重构
概述
文档重构是为项目重新组织文档结构以提升清晰度和可访问性的过程。
关键内容
- 分析项目：识别类型（库/API/Web 应用/CLI/微服务）、架构和用户角色
- 集中管理文档：将技术文档迁移到
docs/，并保留正确的交叉引用 - 整理根目录 README.md：将其精简为入口页，包含概览、快速开始、模块/组件摘要、许可证和联系方式
- 为组件补充文档：添加模块/包/服务级别的 README 文件，包含安装和测试说明
- 按主题组织
docs/：架构、API Reference、数据库、设计、故障排查、部署、贡献等（根据项目需要调整） - 创建指南（按需选择）：用户指南、API 文档、开发指南、部署指南等
- 使用 Mermaid 图表：所有图表都使用 Mermaid（架构图、流程图、Schema 图）
文档重构的目标是保持文档简洁、易扫读，并与项目类型保持上下文一致。
来源
- doc-refactor.md — 原始文档定义
相关
- 文档结构 — relates_to
- 项目文档 — relates_to
- 技术写作 — relates_to