tonytech/library-picturebook-activity
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
922f650365
library-picturebook-activity/docs/sop/document-standards.md
aid 418aa57ea8 Day4: 超管端设计优化 + UGC绘本创作社区P0实现 
一、超管端设计优化
- 文档管理SOP体系建立，docs目录重组
- 统一用户管理：跨租户全局视角，合并用户管理+公众用户
- 活动监管全模块重构：全部活动（统计卡片+阶段筛选+SuperDetail详情页）、报名数据/作品数据/评审进度（两层合一扁平列表）、成果发布（去Tab+统计+隐藏写操作）
- 菜单精简：移除评委管理/评审规则/通知管理
- Bug修复：租户编辑丢失隐藏菜单、pageSize限制、主色统一

二、UGC绘本创作社区P0
- 数据库：10张新表（user_works/user_work_pages/work_tags等）
- 子女账号独立化：Child升级为独立User，家长切换+独立登录
- 用户作品库：CRUD+发布审核，8个API
- AI创作流程：提交→生成→保存到作品库，4个API
- 作品广场：首页改造为推荐流，标签+搜索+排序
- 内容审核（超管端）：作品审核+作品管理+标签管理
- 活动联动：WorkSelector作品选择器
- 布局改造：底部5Tab（发现/创作/活动/作品库/我的）

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-27 22:20:25 +08:00

3.8 KiB
Raw Blame History

文档管理规范（SOP）

本文档定义项目文档的分类、命名、模板和维护规范。所有新增文档必须按此规范执行。

1. 目录结构

docs/
├── project/                    # 项目级文档（整体架构、需求、数据库等）
│   ├── 01-requirements.md
│   ├── 02-architecture.md
│   ├── 03-database-design.md
│   ├── 04-feature-design.md
│   ├── 05-development-plan.md
│   ├── 06-glossary.md
│   ├── 07-system-overview.md
│   ├── 08-test-plan.md
│   └── 09-test-results.md
│
├── design/                     # 功能设计文档（按端 → 按模块）
│   ├── README.md               # 设计文档索引
│   ├── super-admin/            # 超管端
│   │   └── unified-user-management.md
│   ├── org-admin/              # 机构管理端
│   ├── public/                 # 公众端
│   └── judge/                  # 评委端
│
├── deployment/                 # 部署运维文档
│   ├── backend-deployment.md
│   └── frontend-deployment.md
│
├── sop/                        # 流程规范
│   └── document-standards.md   # 本文档
│
└── legacy/                     # 已归档的旧文档（重构前遗留，仅保留参考）

2. 文档分类

分类 目录 说明 示例
项目级 docs/project/ 整个项目的顶层设计，跨模块跨端 需求概述、系统架构、数据库设计
功能设计 docs/design/{端}/ 某个端某个模块的需求分析 + 设计方案 超管端统一用户管理
部署运维 docs/deployment/ 环境搭建、部署流程、运维手册 后端部署、前端部署
流程规范 docs/sop/ 团队协作规范、开发流程 本文档
归档 docs/legacy/ 重构前的旧文档，不再更新 旧版比赛模块设计

3. 功能设计文档模板

每个功能设计文档使用以下结构：

# {模块名称} — 设计方案

> 所属端：超管端 / 机构管理端 / 公众端 / 评委端
> 状态：设计中 / 开发中 / 已完成
> 创建日期：YYYY-MM-DD
> 最后更新：YYYY-MM-DD

---

## 1. 背景与问题

为什么要做这个功能/改造？当前存在什么问题？

## 2. 现状分析

当前的实现方式、涉及的页面和接口、数据结构。

## 3. 设计方案

### 3.1 整体思路

一句话概括方案。

### 3.2 页面设计

页面结构、交互逻辑、UI 布局说明。

### 3.3 后端改动

接口变更、新增接口、数据模型变更。

### 3.4 前端改动

涉及的文件、组件结构、状态管理。

## 4. 改动范围

列出所有需要新增/修改/删除的文件。

## 5. 实施记录

开发过程中的关键决策和变更记录。

4. 命名规范

4.1 文件命名

  • 功能设计文档：{功能名-英文短横线}.md，如 unified-user-management.md
  • 项目级文档：{序号}-{名称}.md，如 01-requirements.md
  • 全小写，单词间用短横线 - 连接

4.2 端目录命名

端 目录名
超管端 super-admin/
机构管理端 org-admin/
公众端 public/
评委端 judge/

5. 维护规则

  1. 先设计后开发：功能开发前，必须先在 docs/design/ 创建设计文档，经确认后再编码
  2. 开发中同步更新：实施过程中如有方案变更，及时更新设计文档的"实施记录"部分
  3. 完成后标记状态：开发完成后将文档状态改为"已完成"
  4. 不删只归档：过时文档移入 legacy/，不直接删除
  5. 索引及时更新：新增设计文档后，更新 docs/design/README.md 索引