3.7 KiB

Raw Blame History Unescape Escape

CasualtySightPlus 项目文档

本目录包含CasualtySightPlus项目的所有技术文档，按照功能分类组织。

文档目录结构

📋 planning/ - 项目规划文档

项目规划、需求分析、架构设计等高层次规划文档

当前文档:

task.md - 项目任务分解和进度跟踪
project_structure_plan.md - 项目结构重构规划
refactor_impact_assessment.md - 重构影响评估和风险分析
code_refactor_plan.md - 代码重构和模块化改造计划
functional_modules_specification.md - 功能模块详细规格说明

后续文档:

requirements_specification.md - 系统需求规格说明
architecture_design.md - 系统架构设计
ui_design_specification.md - UI设计规范

🛠️ technical/ - 技术文档

API文档、组件设计、技术实现细节等

后续文档:

api_documentation.md - API接口文档
component_design.md - 组件设计文档
coding_standards.md - 编码规范
build_instructions.md - 构建说明
deployment_guide.md - 部署指南

🗄️ database/ - 数据库文档

数据库设计、表结构、迁移脚本等

当前文档:

database_schema.sql - 原始数据库表结构定义
updated_database_schema.sql - 更新的数据库表结构（统一设备表）
database_design.md - 数据库设计详细说明

后续文档:

migration_scripts/ - 数据迁移脚本目录
performance_optimization.md - 数据库性能优化

📊 reports/ - 项目报告

阶段性完成报告、测试报告、性能分析等

当前文档:

phase1_completion_report.md - Phase 1完成报告
code_refactor_summary.md - 代码重构和模块化改造总结

后续文档:

phase2_completion_report.md - Phase 2完成报告
phase3_completion_report.md - Phase 3完成报告
testing_report.md - 测试报告
performance_analysis.md - 性能分析报告
final_project_report.md - 最终项目报告

🔄 git/ - 版本控制文档

Git工作流程、分支策略、代码审查等

当前文档:

git_branch_strategy.md - Git分支管理策略

后续文档:

code_review_guidelines.md - 代码审查指南
commit_message_standards.md - 提交信息规范
release_process.md - 发布流程

文档维护规范

文档命名约定

使用小写字母和下划线分隔：file_name.md
文档类型后缀：.md（Markdown）、.sql（SQL脚本）、.json（配置文件）
版本化文档：document_name_v1.0.md

文档内容要求

标题层次: 使用标准的Markdown标题层次（# ## ### ####）
目录: 长文档需要包含目录
更新日期: 每次重要更新需要记录修改日期
作者信息: 标明文档作者和维护者
版本信息: 重要文档需要版本号

文档审查流程

新建或重大修改的文档需要经过代码审查
文档变更与代码变更同步进行
定期review文档的准确性和时效性

快速导航

新团队成员必读

开发者必读

项目经理必读

文档更新日志

日期	文档	变更描述	作者
2025-06-18	全部	初始化文档目录结构，迁移Phase 1文档	Claude

注意: 本文档目录遵循项目开发进度动态更新，请定期查看最新版本。