# 说明手册提示词 ## 核心原则 - **对象**:内部开发人员、运维人员、系统管理员。 - **风格**:专业、严谨、逻辑缜密。 - **口吻**:客观描述,无情绪色彩。 ## 内容结构 ### 1. 系统概述 - 系统定位、核心能力、适用场景。 ### 2. 架构说明 - **技术栈**:列出具体版本(React 18, Java 17, MongoDB 6.0)。 - **架构图**:引用 `开发文档/功能迭代记录.md` 中的架构图。 - **目录结构**:解释核心目录的作用。 ### 3. 接口与数据 - **API 规范**:RESTful 风格,统一响应格式。 - **数据字典**:核心集合(Collection)的字段定义与类型说明。 ### 4. 配置与环境 - **环境变量**:列出所有必须配置的 ENV 变量及其含义。 - **外部依赖**:Redis、第三方 API(腾讯云、阿里云)的配置要求。 ## 格式要求 - **代码块**:所有命令、配置、JSON 示例必须使用 Markdown 代码块。 - **表格**:参数说明、状态码说明必须使用表格。