Files
insar-management-system-v2/docs/INDEX.md
T

7.5 KiB
Raw Blame History

当前文档总览

这是 docs/ 目录的统一入口文档。

从现在开始,docs/ 根目录只保留“当前仍在使用”的文档;历史过程材料、已完成实施记录、被新文档覆盖的旧方案,统一放入 docs/archive/

1. 当前有效文档

核心使用

  • README.md
    系统主文档。优先阅读,包含整体功能、架构、快速开始和主要配置说明。
  • DEPLOYMENT.md
    部署与运维细节文档。适合正式部署、数据库初始化、服务启动和环境核对时使用。
  • PROJ_CONFIGURATION.md
    PROJ/GDAL 相关专项配置说明。只有在坐标转换或 PROJ 冲突时才需要单独查看。

当前安全状态

  • SECURITY_AUDIT_2026-03-12.md
    当前有效的安全审计结论。已经把“开发机阶段可接受暴露”和“上线前必须修复的问题”分开说明,后续安全判断以这份为准。

仍在推进的设计与任务

2. 已归档文档

以下文档已移入 docs/archive/,原因通常是“历史记录”“已完成实施”或“被后续结论覆盖”。

本轮归档

  • SECURITY_AUDIT_2026-03-04.md
  • SECURITY_AUDIT_ANALYSIS_2026-03-04.md
  • SECURITY_FIX_PLAN.md
  • SECURITY_FIX_PROGRESS.md
  • SECURITY_FIX_CHECKLIST.md
  • SECURITY_FIX_STAGE1_SUMMARY.md
  • SECURITY_OVERVIEW.md
  • HARDCODE_AUDIT_2026-03-05.md
  • LOG_MANAGEMENT_IMPLEMENTATION_2026-03-05.md

既有归档

docs/archive/ 中原有的旧设计、旧 TODO、阶段性分析和历史修复记录继续保留,仅作历史参考,不再视为当前执行依据。

3. 建议阅读顺序

新接手项目

  1. 先读 README.md
  2. 再读 DEPLOYMENT.md
  3. 若涉及上线前风险,再读 SECURITY_AUDIT_2026-03-12.md

正式部署

  1. README.md
  2. DEPLOYMENT.md
  3. PROJ_CONFIGURATION.md(仅在需要时)

后续功能规划

  1. DINSAR_ENHANCEMENT_TASKS.md
  2. PAIRING_ENHANCEMENT_DESIGN.md
  3. PAIRING_SYSTEM_REFACTOR_PLAN_20260413.md
  4. ISCE2_SBAS_TIMESERIES_DESIGN.md
  5. WSL2_ISCE2_MINTPY_SBAS_INTEGRATION_PLAN_20260412.md
  6. GAMMA_WSL2_INTEGRATION_PLAN.md
  7. PYINT_GAMMA_INTEGRATION_DESIGN_20260418.md
  8. PYINT_GAMMA_IMPLEMENTATION_TODO_20260418.md
  9. PYINT_INPUT_ASSET_ADAPTATION_DESIGN_20260419.md
  10. PYINT_LT1_COREG_ORBIT_HYPOTHESIS_EXPERIMENT_20260420.md
  11. PYINT_LT1_DEM_GEOMETRY_CHAIN_EXPERIMENT_20260420.md

4. 后续维护规则

  • docs/ 根目录只放当前有效文档。
  • 已完成实施总结、阶段性修复过程、旧审计分析、被覆盖方案,统一放入 docs/archive/
  • 新增文档前,优先判断是否可以并入现有文档,避免再次堆出多份并行说明。
  • 如果某份文档只记录一次任务过程,而不是长期参考资料,不应继续留在根目录。

最后整理2026-03-13