diff --git a/CLAUDE.md b/CLAUDE.md index 01726b8..95349d6 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -2,6 +2,25 @@ 本文档为 Claude Code (claude.ai/code) 在此代码库中工作时提供指导。 +## 重要说明 +- @agent-technical-writer --think-hard + docs目录下是你之前结合代码库为我生成的详细设计文档的部分章节,以一个章节对应一个文件的形式存在,,现在需要你对比docs目录和template目 + 录下的文档,template目录下的文档是作为参考的文档模板,包含4个章节的片段,结合代码库的实现调整docs目录下对应的4个文档片段的内容并进行 + 扩充,需要留意docs目录下的todo.md的要求,并且在todo.md中记录工作步骤并保持追踪。你要先阅读todo.md再开始工作,例如先对比并修改第4章就 + 更新todo.md并停止执行,等我下达命令再继续对比第5章,以此类推。由于文档内容比较多,你一个一个对比,不要全部加载到上下文再去对比 +- 每次执行任务前要回顾docs/todo.md的内容 +- 这个项目是黑石咀水库的,不是山洪灾害四预系统项目的,我让你参考山洪灾害四预系统项目的设计文档的行文风格和排版来编写 + 黑石咀项目的详细设计文档 +- 生成的文档内容要参考代码库已有的实现,但是不要把具体代码写入文档 +- 你的任务很重要的一部分工作是扩充文档内容,切记这一点,但是不要写大量的与代码库内容无关的内容 +- 只需要编写第4、5、6、7章 +- 第6章不需要编写6.3数据库设计章节内容 +- 保持与现有代码库的一致性 +- 确保文档的技术准确性 +- 不要写具体代码实现的内容,如果一定要写与代码相关的内容,使用自然语言来描述逻辑 +- 保持小章节的序号,如4.1、4.2等 +- 如果文档模板实在找不到与代码库对应的内容,留空,不要擅自填写不相干的内容 +- ## 项目概述 **黑石咀水库系统** - 湖北省山洪灾害防治综合洪水监测预警系统。这是一个基于 Spring Boot 3.x 的 Java 应用程序,实现了山洪灾害监测管理的"四预"系统(预报/预警/预演/预案)。 @@ -214,10 +233,3 @@ src/main/java/com/gunshi/project/hsz/ - 使用`mvn spring-boot:run`运行应用程序 - 使用适当的凭据测试外部API连接 -## 重要说明 - -- 本系统处理关键的洪水监测数据 - 确保数据完整性和可靠性 -- 外部API集成需要适当的认证和错误处理 -- 预警系统具有实时要求 - 优化性能以确保及时告警 -- 数据库性能对于大规模监测数据处理至关重要 -- 遵循定时任务和数据同步的现有模式 \ No newline at end of file