本目录包含 Daymica 项目的各类技术文档、设计文档和操作指南。
- - -
## 文档分类
### 核心规范文档
| 文档 | 描述 | |\-\-\-\-\-\-|\-\-\-\-\-\-| | `STYLE_SYSTEM.md | 样式系统规范（颜色、间距、文本、动画等） | | AI_CODING_TEMPLATES.md | AI代码生成模板 | | COMPONENT_SHOWCASE.md | 组件展示说明 | | PERFORMANCE_ANALYSIS.md` | 性能问题分析 |
### 架构设计 \(`architecture/)`
`| 文档 | 描述 | |------|------| | TAG_MANAGEMENT_FLOW.md | 标签管理流程设计 | | backend_membership_guard.md` | 后端会员权限保护 |
### API 文档 \(`api/)`
`| 文档 | 描述 | |------|------| | API_DATE_FORMAT.md` | API 日期格式规范 |
### 性能优化 \(`performance/)`
`| 文档 | 描述 | |------|------| | PERFORMANCE_OPTIMIZATION_SUMMARY.md` | 性能优化总结 |
### 部署相关 \(`deployment/)`
`| 文档 | 描述 | |------|------| | RELEASE.md | 应用发布流程指南 | | MYSQL_SCHEMA.md` | MySQL 数据库 schema 定义 |
### 操作指南 \(`guides/)`
`| 文档 | 描述 | |------|------| | CONTRIBUTING.md | 贡献指南 | | RUNBOOK.md` | 运维手册 |
### 商业相关 \(`business/)`
`| 文档 | 描述 | |------|------| | BUSINESS_MODEL.md | 商业模型（最新定价策略） | | daymica-ai-plan.md` | AI 转型规划（早期规划，部分信息已过时） |
### 功能文档 \(`features/)`
`| 文档 | 描述 | |------|------| | stt_platform_support.md` | 语音转文字平台支持 |
### 设计文档 \(`design/)`
`| 文档 | 描述 | |------|------| | flomo-ui-plan.md | Flomo UI 设计方案 | | local_settings_storage_design.md` | 本地设置存储设计 |
### 研究报告 \(`research/)`
`| 文档 | 描述 | |------|------| | roadmap_analysis_report.md` | 路线图分析报告 |
### 归档文档 \(`archived/)`
已归档的历史文档，包括：
- 已完成的功能设计（PC结构重设计相关）
- 过期的调研报告
- 已执行的迁移文档
- 已完成的功能交接
### 计划文档 \(`../plans/)`
`| 文档 | 描述 | |------|------| | commit_plan_by_features.md` | 功能提交计划 |
### 其他目录
- `migrations/ - 数据库迁移脚本目录`
- `superpowers/ - 超级功能相关文档（进行中/未完成的计划和规格）`
- `superpowers/archive/ - 已完成的超级功能计划和规格`
- - -
## 文档规范
### Markdown 格式
- 使用标准 Markdown 语法
- 标题层级清晰（\# \#\# \#\#\#）
- 代码块使用正确的语言标记
### 图表
- 使用 Mermaid 语法绘制流程图
- 使用 ASCII 艺术表示简单架构
### 更新维护
- 文档应与代码保持同步
- 重大变更需更新相关文档
- 废弃功能需标注 deprecated
- - -
## 如何贡献
1. **新增文档**
- **选择合适的分类目录**
- **使用清晰的文件名**
- **添加文档到本 README 的列表**
2. **更新文档**
- **保持文档的时效性**
- **记录变更历史（如适用）**
3. **文档审查**
- **确保技术准确性**
- **检查代码示例可运行**
- **验证链接有效性**
- - -
## 相关资源
- `AGENTS.md - AI 助手开发指南（项目根目录）`
- `CLAUDE.md - Claude Code 指南（项目根目录）`
- `README.md - 项目主文档（项目根目录）`
- `CHANGELOG.md - 版本更新日志（项目根目录）`
- - -
## 文档更新日志
### 2026\-04\-02
- 清理过期分析日志文件（16个）
- 归档已完成的设计文档和计划
- 合并重复示例文档
- 更新文档目录索引
### 2026\-03\-26
- 重新组织文档结构，按功能分类
---
来自 Daymica