MindGuard 项目文档
字数
8591 字
阅读时间
34 分钟
项目文档简介
docs/ 目录是 MindGuard 小程序的项目知识库与规范基线，涵盖了从功能设计、页面实现、样式规范到数据库设计、项目管理和开发方案的完整文档体系。
仓库规范与开发指南
- 仓库结构与模块组织
miniprogram/：前端小程序代码。pages/核心 Tab 页面；packages/分包页面；components/可复用组件；services/接口封装；utils/工具方法；mock/本地数据。
cloudfunctions/：云开发函数，一函数一目录（如checkinRecorder、suggestionOrchestrator）。docs/：产品/UX/技术文档；dify/：AI 工作流与编排资产。- 根配置：
app.json、project.config.json、project.private.config.json。
- 构建与本地开发
- 安装依赖：
cd miniprogram && npm install，随后在微信开发者工具执行“构建 npm”。 - 打开项目：使用微信开发者工具（v1.06+）打开目录
miniprogram/。 - 运行时切换 Mock：DevTools 控制台执行
wx.setStorageSync('USE_MOCK', false)。 - 部署云函数：开发者工具 → 云开发 → 云函数 → 上传（逐个校验每个函数的
index.js）。
- 安装依赖：
- 代码风格与命名
- JS：
'use strict';、2 空格缩进、单引号、分号、const/let、CommonJS（require/module.exports）。 - 命名：页面
data字段与事件处理使用小驼峰（如handleCheckinTap）；WXML 类名使用短横线（如today-page、risk-banner）。 - JSON：2 空格缩进；在可行时对 key 做有序输出；未配置 linter，保持与现有风格一致。
- JS：
- 测试指南
- 暂无自动化测试，使用微信开发者工具的预览与模拟器进行手测。
- 覆盖关键路径：Today 情绪打卡、日记编辑、SOS 流程、个人资料更新。
- 保障离线 QA：如服务字段有变更，同步更新
miniprogram/mock/*.json。 - 新增功能时在
docs/补充或更新对应文档。
- 提交与 PR 规范
- 使用 Conventional Commits：
feat:、fix:、docs:、chore:。 - 变更范围聚焦，注明受影响的包/模块。
- PR 请包含：问题陈述、方案概述、截图/日志、关联任务或 Issue。
- 若云函数 API 有破坏性变更，请显著标注并同步更新相关文档/片段。
- 使用 Conventional Commits：
- 安全与配置
- 不提交凭证/租户 ID；放置于
project.private.config.json或云控制台。 - 清洗用户内容，避免记录个人敏感数据。
- 新的全局开关通过
App.globalData.env暴露，并允许通过 Storage 覆盖。
- 不提交凭证/租户 ID；放置于
目录结构
text
docs/
├── README.md # 文档导航索引（本文件）
├── 功能列表.md # 全功能索引与快速定位
├── UI组件文档.md # 通用组件规范与使用指南
├── 接口占位文档.md # API接口定义与协作规范
├── 用户流程说明.md # 核心用户交互路径说明
├── 分包规划方案.md # 小程序分包策略与性能优化
├── 测试用例.md # 测试覆盖场景与验收标准
├── 埋点与数据分析.md # 埋点方案与数据看板设计
├── 上线说明.md # 小程序提审与发布指南
├── 迭代计划.md # 版本管理与迭代流程
├── 运维与监控.md # 运行期监控与运维策略
├── FAQ与用户反馈.md # 常见问题与反馈处理流程
├── 数据库设计.md # 数据库设计总览
├── 功能文档/ # 按功能模块拆分的实现文档
│ ├── 功能-Ask心理助理.md # AI智能对话助手功能设计
│ ├── 功能-SOS安全守护.md # 紧急求助与危机干预功能
│ ├── 功能-护心周报.md # 个人心理健康周报生成
│ ├── 功能-徽章成就体系.md # 成就系统与激励设计
│ ├── 功能-快速记一笔.md # 快速日记记录功能
│ ├── 功能-清单任务管理.md # 清单式任务管理功能
│ ├── 功能-情绪打卡.md # 情绪状态记录与分析
│ ├── 功能-情绪趋势.md # 情绪趋势分析展示
│ ├── 功能-情绪趋势与标签分析.md # 情绪数据标签化分析
│ ├── 功能-任务卡执行闭环.md # 任务管理与执行跟踪
│ ├── 功能-树洞抱抱与互动反馈.md # 社区情感互动反馈
│ ├── 功能-树洞发帖与草稿自检.md # 社区发布与风险自检
│ ├── 功能-树洞风险提示与温和守护.md # 风险识别与守护机制
│ ├── 功能-晚安模式与低扰提醒.md # 夜间免打扰模式
│ ├── 功能-微建议与任务生成.md # AI个性化建议生成
│ ├── 功能-心情随笔与多模录入.md # 多模态日记记录功能
│ ├── 功能-行动卡领取与同步.md # 行动建议转化与同步
│ ├── 功能-学生端异常流程处理机制.md # 用户异常处理机制
│ ├── 功能-学校协同系统.md # 校园心理协同机制
│ ├── 功能-隐私授权中心.md # 隐私设置与授权管理
│ ├── 功能-账号与资料管理.md # 用户账户与资料管理
│ ├── 功能-专题工具箱入口.md # 专题工具集合入口
│ ├── 功能-资源地图导航.md # 心理支持资源导航
│ └── 功能-资源推送系统.md # 个性化资源推送机制
├── 页面文档/ # 各页面的详细设计文档
│ ├── README.md # 页面文档索引与状态
│ ├── 页面-SOS-主页.md # SOS紧急求助主页设计
│ ├── 页面-SOS-资源切换.md # SOS救助资源切换页面
│ ├── 页面-个人-护心周报.md # 个人周报查看页面
│ ├── 页面-个人-徽章详情.md # 徽章详情展示页面
│ ├── 页面-个人-审核中心.md # 个人内容审核中心
│ ├── 页面-个人-问题反馈.md # 问题反馈提交页面
│ ├── 页面-个人-学校协同.md # 学校协同功能页面
│ ├── 页面-个人-隐私中心.md # 隐私设置管理页面
│ ├── 页面-个人-资料编辑.md # 个人资料编辑页面
│ ├── 页面-个人-资源地图.md # 心理资源地图页面
│ ├── 页面-呼吸-主页.md # 呼吸训练主页设计
│ ├── 页面-今天.md # 今天Tab首页设计
│ ├── 页面-任务.md # 任务管理主页面设计
│ ├── 页面-任务域-任务详情.md # 任务详情查看页面
│ ├── 页面-日记域-日记编辑.md # 日记编辑页面设计
│ ├── 页面-日记域-日记详情.md # 日记详情查看页面
│ ├── 页面-日记域-周报导出.md # 周报生成与导出页面
│ ├── 页面-社区-发布帖子.md # 社区内容发布页面
│ ├── 页面-社区-话题聚合.md # 社区话题聚合页面
│ ├── 页面-社区-活动广场.md # 社区活动广场页面
│ ├── 页面-社区-客服与帮助.md # 客服帮助中心页面
│ ├── 页面-社区-搜索.md # 社区内容搜索页面
│ ├── 页面-社区-帖子详情.md # 社区帖子详情页面
│ ├── 页面-社区-消息中心.md # 社区消息中心页面
│ ├── 页面-社区-心理咨询.md # 心理咨询服务页面
│ ├── 页面-社区-行动卡反馈.md # 行动卡反馈页面
│ ├── 页面-社区-学术资源.md # 学术资源页面
│ ├── 页面-社区-预约中心.md # 预约服务中心页面
│ ├── 页面-社区-资源广场.md # 社区资源广场页面
│ ├── 页面-树洞.md # 树洞社区主页面设计
│ ├── 页面-我的.md # 个人中心主页面设计
│ ├── 页面-心情随笔.md # 心情随笔主页面设计
│ ├── 页面-正念-主页.md # 正念训练主页设计
│ └── 页面-资源推送.md # 资源推送页面设计
├── 前端样式/ # 样式规范与设计资源
│ ├── 色彩系统.md # 心理健康场景色彩设计规范
│ ├── html/ # HTML格式的样式文档
│ │ └── 可运行设计图.html # 可交互的设计图文件
│ ├── png/ # PNG格式图片资源
│ │ ├── 高保真图-今天.png # 今天页面高保真设计图
│ │ ├── 高保真图-情绪趋势.png # 情绪趋势高保真图
│ │ ├── 高保真图-任务.png # 任务页面高保真图
│ │ ├── 高保真图-树洞.png # 树洞页面高保真图
│ │ ├── 高保真图-我的.png # 个人中心高保真图
│ │ └── 高保真图-心情随笔.png # 心情随笔高保真图
│ ├── svg/ # SVG矢量图资源
│ │ ├── 高保真图-今天.svg # 今天页面高保真设计图
│ │ ├── 高保真图-情绪趋势.svg # 情绪趋势高保真图
│ │ ├── 高保真图-任务.svg # 任务页面高保真图
│ │ ├── 高保真图-树洞.svg # 树洞页面高保真图
│ │ ├── 高保真图-我的.svg # 个人中心高保真图
│ │ ├── 高保真图-心情随笔.svg # 心情随笔高保真图
│ │ ├── 高保真图-学校协同.svg # 学校协同功能高保真图
│ │ └── 高保真图-资源推送.svg # 资源推送高保真图
│ └── 样式规范/ # 各页面样式规范文档
│ ├── README.md # 样式规范索引文档
│ ├── px到rpx转换总结.md # 像素单位转换规范
│ ├── SOS-主页.md # SOS页面样式规范
│ ├── 个人-隐私中心.md # 隐私中心样式规范
│ ├── 个人-资料编辑.md # 资料编辑样式规范
│ ├── 呼吸-主页.md # 呼吸训练样式规范
│ ├── 今天.md # 今天页面样式规范
│ ├── 批量覆盖报告.md # 样式覆盖测试报告
│ ├── 情绪趋势.md # 情绪趋势样式规范
│ ├── 任务.md # 任务页面样式规范
│ ├── 树洞.md # 树洞页面样式规范
│ ├── 我的.md # 个人中心样式规范
│ ├── 心情随笔.md # 心情随笔样式规范
│ ├── 学校协同.md # 学校协同样式规范
│ ├── 正念-主页.md # 正念训练样式规范
│ └── 资源推送.md # 资源推送样式规范
├── 数据库/ # 数据库设计与集合文档
│ ├── 关系图与依赖.md # 数据关系可视化图表
│ ├── 索引与约定.md # 数据库索引设计规范
│ ├── 校验与迁移策略.md # 数据验证与迁移方案
│ ├── 版本历史.md # 数据库版本变更记录
│ ├── 集合-SOS事件.sos.md # SOS事件数据集合设计
│ ├── 集合-徽章.badges.md # 徽章成就数据集合设计
│ ├── 集合-情绪打卡.checkins.md # 情绪打卡数据集合设计
│ ├── 集合-任务.tasks.md # 任务管理数据集合设计
│ ├── 集合-树洞互动.comments.md # 树洞互动数据集合设计
│ ├── 集合-树洞帖子.posts.md # 树洞帖子数据集合设计
│ ├── 集合-通知.notifications.md # 通知消息数据集合设计
│ ├── 集合-微建议.suggestions.md # AI建议数据集合设计
│ ├── 集合-心情随笔.journals.md # 日记内容数据集合设计
│ ├── 集合-用户.users.md # 用户信息数据集合设计
│ ├── 集合-用户反馈.feedback.md # 用户反馈数据集合设计
│ ├── 集合-用户事件.events.md # 用户行为事件数据集合设计
│ ├── 集合-周报与风控.reports.md # 周报与风控数据集合设计
│ ├── 集合-资源地图.resources.md # 心理资源数据集合设计
│ ├── 集合-AI对话会话.ask_sessions.md # AI对话会话数据集合设计
│ ├── 集合-AI对话消息.ask_messages.md # AI对话消息数据集合设计
│ └── 集合-CBT应用记录.cbt_applications.md # CBT应用记录数据集合设计
├── 接口/ # 接口详细设计文档
│ ├── 接口-sosRelay.md # SOS中继服务接口设计
│ ├── 接口-suggestionOrchestrator.md # 建议协调器接口设计
│ └── 接口-treeholeModeration.md # 树洞审核服务接口设计
├── 开发方案/ # 开发架构与扩展方案
│ ├── tab页设计蓝图.md # Tab页面架构设计方案
│ ├── 功能扩展.md # 功能扩展与插件化设计方案
│ └── 社区导向整体开发方案.md # 社区功能整体开发策略
├── 项目计划/ # 项目管理与计划文档
│ ├── RACI与沟通节奏.md # 角色职责矩阵与沟通机制
│ ├── 工作分解结构WBS.md # 项目任务分解结构文档
│ ├── 总计划-里程碑与时间线.md # 项目里程碑时间计划
│ ├── 风险清单与应对.md # 风险识别与应对策略文档
│ ├── 任务清单-看板.md # 项目任务管理看板
│ └── 质量门禁与验收标准.md # 质量标准与验收流程文档
└── UI组件/ # 通用UI组件库文档
├── README.md # 组件库索引文档
├── custom-navbar.md # 自定义导航栏组件设计
├── empty-state.md # 空状态提示组件设计
├── post-card.md # 帖子卡片组件设计
├── rebt-inline.md # REBT内联组件设计
├── risk-banner.md # 风险提示横幅组件设计
├── stats-row.md # 统计信息行组件设计
├── topic-chip.md # 话题标签组件设计
├── 命名与API一致化建议.md # 组件命名规范建议
└── 校验报告.md # 组件库校验报告导航索引
功能文档索引
情绪健康闭环
- 功能-情绪打卡 - 情绪状态记录与心情轮可视化
- 功能-情绪趋势 - 情绪趋势分析与展示
- 功能-情绪趋势与标签分析 - 情绪数据标签化分析
- 功能-微建议与任务生成 - AI驱动的个性化建议生成
- 功能-任务卡执行闭环 - 任务管理与执行跟踪闭环
- 功能-清单任务管理 - 清单式任务管理功能
- 功能-心情随笔与多模录入 - 多模态日记记录功能
- 功能-快速记一笔 - 快速日记记录功能
- 功能-护心周报 - 个人心理健康周报生成
社区守护系统
- 功能-树洞发帖与草稿自检 - 社区发布与风险自检机制
- 功能-树洞风险提示与温和守护 - 风险识别与守护机制
- 功能-树洞抱抱与互动反馈 - 社区情感互动反馈
- 功能-行动卡领取与同步 - 行动建议转化与同步
安全保障与个人中心
- 功能-SOS安全守护 - 紧急求助与危机干预系统
- 功能-晚安模式与低扰提醒 - 夜间免打扰模式
- 功能-隐私授权中心 - 隐私设置与授权管理
- 功能-账号与资料管理 - 用户账户与资料管理
- 功能-资源地图导航 - 心理支持资源导航
AI智能与成长体系
- 功能-Ask心理助理 - AI智能对话助手
- 功能-徽章成就体系 - 成就系统与激励设计
- 功能-资源推送系统 - 个性化资源推送机制
辅助功能与系统
- 功能-学生端异常流程处理机制 - 用户异常处理机制
- 功能-学校协同系统 - 校园心理协同机制
- 功能-专题工具箱入口 - 专题工具集合入口
页面文档索引
主包Tab页面
- 页面-今天 - 今天Tab首页与情绪打卡入口
- 页面-心情随笔 - 心情随笔主页面与日记入口
- 页面-任务 - 任务管理主页面与任务列表
- 页面-树洞 - 树洞社区主页面与信息流
- 页面-我的 - 个人中心主页面与功能总览
独立分包（SOS）
- 页面-SOS-主页 - SOS紧急求助主页设计
- 页面-SOS-资源切换 - SOS救助资源切换页面
日记域分包
- 页面-日记域-日记编辑 - 日记编辑页面设计
- 页面-日记域-日记详情 - 日记详情查看页面
- 页面-日记域-周报导出 - 周报生成与导出页面
- 页面-任务域-任务详情 - 任务详情查看页面
社区分包
- 页面-社区-帖子详情 - 社区帖子详情页面
- 页面-社区-发布帖子 - 社区内容发布页面
- 页面-社区-话题聚合 - 社区话题聚合页面
- 页面-社区-行动卡反馈 - 行动卡反馈页面
- 页面-社区-活动广场 - 社区活动广场页面
- 页面-社区-客服与帮助 - 客服帮助中心页面
- 页面-社区-搜索 - 社区内容搜索页面
- 页面-社区-消息中心 - 社区消息中心页面
- 页面-社区-心理咨询 - 心理咨询服务页面
- 页面-社区-学术资源 - 学术资源页面
- 页面-社区-预约中心 - 预约服务中心页面
- 页面-社区-资源广场 - 社区资源广场页面
个人中心分包
- 页面-个人-护心周报 - 个人周报查看页面
- 页面-个人-徽章详情 - 徽章详情展示页面
- 页面-个人-审核中心 - 个人内容审核中心
- 页面-个人-问题反馈 - 问题反馈提交页面
- 页面-个人-学校协同 - 学校协同功能页面
- 页面-个人-隐私中心 - 隐私设置管理页面
- 页面-个人-资料编辑 - 个人资料编辑页面
- 页面-个人-资源地图 - 心理资源地图页面
其他功能页面
样式规范与高保真图
色彩系统
- 色彩系统 - 心理健康场景的色彩设计规范
页面样式规范
- 今天页面样式 - 今天Tab页面样式规范
- 心情随笔样式 - 心情随笔页面样式规范
- 任务页面样式 - 任务管理页面样式规范
- 树洞页面样式 - 树洞社区页面样式规范
- 个人中心样式 - 个人中心页面样式规范
- SOS页面样式 - SOS紧急求助页面样式规范
- 个人隐私中心样式 - 隐私中心页面样式规范
- 个人资料编辑样式 - 资料编辑页面样式规范
- 呼吸训练样式 - 呼吸训练页面样式规范
- 情绪趋势样式 - 情绪趋势页面样式规范
- 学校协同样式 - 学校协同页面样式规范
- 正念训练样式 - 正念训练页面样式规范
- 资源推送样式 - 资源推送页面样式规范
- px到rpx转换规范 - 像素单位转换技术规范
- 批量覆盖报告 - 样式覆盖测试报告
高保真设计图
- 今天页面 - 今天Tab高保真设计图
- 情绪趋势页面 - 情绪趋势高保真设计图
- 任务管理页面 - 任务页面高保真设计图
- 树洞社区页面 - 树洞页面高保真设计图
- 个人中心页面 - 个人中心高保真设计图
- 心情随笔页面 - 心情随笔高保真设计图
- 学校协同页面 - 学校协同功能高保真设计图
- 资源推送页面 - 资源推送高保真设计图
多格式设计资源
- 可运行设计图 - HTML交互式设计图
- PNG格式高保真图 (前端样式/png/) - 图片格式设计资源
数据库文档
数据关系与设计
数据集合文档
- 用户集合 - 用户信息数据集合设计
- 情绪打卡集合 - 情绪打卡数据集合设计
- 心情随笔集合 - 日记内容数据集合设计
- 任务集合 - 任务管理数据集合设计
- 树洞帖子集合 - 社区帖子数据集合设计
- 树洞互动集合 - 社区评论数据集合设计
- 通知集合 - 通知消息数据集合设计
- 微建议集合 - AI建议数据集合设计
- 周报与风控集合 - 周报与风控数据集合设计
- 徽章集合 - 徽章成就数据集合设计
- SOS事件集合 - SOS紧急事件数据集合设计
- 用户反馈集合 - 用户反馈数据集合设计
- 用户事件集合 - 用户行为事件数据集合设计
- 资源地图集合 - 心理资源数据集合设计
项目管理与计划
团队协作与计划
- RACI与沟通节奏 - 角色职责矩阵与沟通机制
- 工作分解结构WBS - 项目任务分解结构文档
- 总计划-里程碑与时间线 - 项目里程碑时间计划
- 风险清单与应对 - 风险识别与应对策略文档
- 任务清单-看板 - 项目任务管理看板
- 质量门禁与验收标准 - 质量标准与验收流程文档
开发方案
- tab页设计蓝图 - Tab页面架构设计方案
- 功能扩展 - 功能扩展与插件化设计方案
- 社区导向整体开发方案 - 社区功能整体开发策略
UI组件库
核心组件
- 自定义导航栏 - 自定义导航栏组件设计
- 空状态组件 - 空状态提示组件设计
- 帖子卡片组件 - 帖子卡片组件设计
- 风险提示横幅 - 风险提示横幅组件设计
- REBT内联组件 - 认知行为疗法内联组件
- 统计信息行 - 统计信息行组件设计
- 话题标签组件 - 话题标签组件设计
规范与校验
开发使用指南
文档阅读顺序建议
- 项目理解：从功能列表开始了解整体功能架构
- 用户流程：阅读用户流程说明理解核心交互路径
- 功能实现：查阅对应功能文档了解具体实现方案
- 页面设计：参考页面文档进行页面级开发
- 样式实现：依照样式规范实现界面
- 接口对接：参考接口占位文档进行前后端联调
- 数据设计：查阅数据库文档理解数据结构
- 测试验收：按照测试用例进行功能验证
开发工作流
需求分析 → 功能文档 → 页面设计 → 接口定义 → 样式实现 → 功能开发 → 测试验证 → 上线部署新功能开发文档要求
开发新功能时需要补充以下文档：
- 功能文档：在
功能文档/目录下创建功能-xxx.md - 页面文档：在
页面文档/目录下创建对应页面文档 - 接口文档：更新
接口占位文档.md或创建专用接口文档 - 数据库设计：在
数据库/目录下创建对应集合文档 - 测试用例：更新
测试用例.md添加新功能测试场景 - 样式规范：在
前端样式/样式规范/目录下创建页面样式文档
更新约定
文档更新原则
- 功能新增：必须同步更新功能文档、页面文档、接口文档、数据库文档
- 页面变更：更新对应页面文档和样式规范文档
- 接口调整：及时更新接口占位文档和相关功能文档
- 数据库变更：更新数据库集合文档和版本历史
- 样式修改：同步更新样式规范文档和相关高保真图
文档维护责任人
- 产品负责人：功能文档、用户流程说明、FAQ文档
- 前端负责人：页面文档、样式规范、UI组件文档
- 后端负责人：接口文档、数据库设计文档
- 测试负责人：测试用例文档、质量标准文档
- 项目经理：项目计划文档、RACI矩阵、里程碑计划
变更记录
| 版本 | 变更日期 | 变更内容 | 责任人 |
|---|---|---|---|
| v1.0 | 2025-09-22 | 初始版本，创建docs目录结构索引文档 | 彩虹雨 |
注意：本文档随项目开发持续更新，请确保查阅最新版本。文档维护请遵循更新约定，确保知识库的准确性和完整性。
贡献者
Cai Hongyu