<prompt> <instruction> 请基于对当前项目代码的扫描和理解，生成一份 markdown 文档，用于团队协作。文档的各个部分应根据项目代码的实际情况进行填充，而非依赖预设的示例。 </instruction> <project_context> <project_name>[请在此处填写你的项目名称]</project_name> <brief_description>[请在此处填写你的项目简要描述]</brief_description> <programming_language_and_frameworks>[请在此处填写项目使用的编程语言和主要框架/库，例如：Go, Gin]</programming_language_and_frameworks> <code_access_method> <repository_url>[请在此处填写你的代码仓库 URL]</repository_url> <branch_or_version>[请在此处填写你希望分析的分支或版本]</branch_or_version> </code_access_method> <documentation_target_audience>[请在此处填写文档的目标读者，例如：新加入的开发人员]</documentation_target_audience> </project_context> <documentation_content> <overall_architecture_overview>请通过扫描项目代码来描述项目的整体架构概览。包括主要组件及其交互方式。如果可能，请生成一个基于代码结构的简单示意图（例如，使用 Mermaid 语法）。</overall_architecture_overview> <code_file_dependency_relationship>请通过分析项目代码来识别代码文件之间的依赖关系，重点关注核心模块之间的依赖。请生成一个详细的依赖关系列表或图表，清晰地展示模块间的引用关系。</code_file_dependency_relationship> <functional_module_call_logic> <instruction>请详细描述以下关键功能模块的调用逻辑，务必基于对项目代码的分析：</instruction> <functional_module> <name>[请在此处填写关键功能模块 1 的名称，例如：用户注册]</name> <description>请详细描述当此功能被触发时，代码中的函数调用链。从入口点开始，追踪涉及的所有函数调用，直到完成该功能。请说明每个函数的名称、所在文件以及其作用。可以使用文字描述或流程图/时序图（例如，使用 Mermaid 语法）。</description> </functional_module> <functional_module> <name>[请在此处填写关键功能模块 2 的名称，例如：创建待办事项]</name> <description>请详细描述当此功能被触发时，代码中的函数调用链。从入口点开始，追踪涉及的所有函数调用，直到完成该功能。请说明每个函数的名称、所在文件以及其作用。可以使用文字描述或流程图/时序图（例如，使用 Mermaid 语法）。</description> </functional_module> <instruction>请根据项目的实际情况，添加更多需要描述函数调用链的关键功能模块。</instruction> </functional_module_call_logic> <key_code_file_location_index> <instruction>请基于对项目代码的理解，列出以下关键代码文件及其详细说明：</instruction> <file> <path>[请在此处填写关键文件路径，例如：main.go]</path> <description>[请在此处填写该文件的详细说明，例如：项目入口文件，负责初始化和启动服务。]</description> </file> <file> <path>[请在此处填写关键文件路径，例如：router/router.go]</path> <description>[请在此处填写该文件的详细说明，例如：定义了 API 的路由规则。]</description> </file> <instruction>请根据项目的实际情况，添加更多需要索引的关键代码文件及其详细说明。</instruction> </key_code_file_location_index> </documentation_content> <additional_context> <naming_conventions_and_design_patterns>[请在此处填写项目遵循的命名约定和设计模式，例如：RESTful API，分层架构]</naming_conventions_and_design_patterns> <modules_or_files_to_emphasize_or_ignore>[请在此处填写需要特别强调或忽略的模块/文件，例如：重点关注用户和任务管理模块，忽略测试代码。]</modules_or_files_to_emphasize_or_ignore> </additional_context> <output_format>markdown</output_format> </prompt>