Initial commit
This commit is contained in:
245
SRS_需求规格说明书_gemini.md.bak
Normal file
245
SRS_需求规格说明书_gemini.md.bak
Normal file
@@ -0,0 +1,245 @@
|
||||
# 奥迪小红书小程序门户 - 需求规格说明书 (SRS) - Part 1
|
||||
|
||||
## 1. 引言 (Introduction)
|
||||
|
||||
### 1.1 目的 (Purpose)
|
||||
本文档旨在详细定义“奥迪中国小红书小程序门户(Audi China Red note mini app portal)”项目的软件需求规格。本文档将作为技术开发、系统测试、项目验收以及后期运维管理的基准文件,确保所有项目干系人对系统功能与非功能边界达成共识。
|
||||
|
||||
### 1.2 文档约定 (Document Conventions)
|
||||
* **格式:** 本文档采用 Markdown 格式编写,业务流程图采用 Mermaid 语法呈现。
|
||||
* **优先级定义:** 需求分为“必须具备 (Must have)”、“应该具备 (Should have)”和“可以具备 (Could have)”。未特别标注的系统特性均视为“必须具备”。
|
||||
* **缩写与术语:** 请参见项目立项初期的《核心术语表(Glossary)》。
|
||||
|
||||
### 1.3 预期读者 (Intended Audience)
|
||||
* **奥迪中国业务团队:** 确认业务流程与合规要求是否准确。
|
||||
* **项目开发团队 (前端/后端/架构):** 作为系统设计与编码的直接依据。
|
||||
* **测试团队 (QA):** 依据本说明书中的业务规则与异常流程编写测试用例。
|
||||
* **IT运维与安全团队:** 评估私有云部署方案、数据保护及 SLA 可行性。
|
||||
|
||||
### 1.4 项目范围 (Project Scope)
|
||||
本项目包含两大部分:
|
||||
1. **2026年系统建设阶段:** 搭建基于安全私有云的第三方内容管理门户,开发小红书小程序前端,并实现与小红书后端及 JV 官网的数据打通。
|
||||
2. **2026-2028年运维阶段:** 提供 7x24 小时的系统 Stand-by 支持,并承担每周的内容运营(图片更新)工作。
|
||||
|
||||
---
|
||||
|
||||
## 2. 总体描述 (Overall Description)
|
||||
|
||||
### 2.1 产品视角 (Product Perspective)
|
||||
本项目是一个独立部署于奥迪私有云环境的“前端展示+后端管理”微型生态系统。
|
||||
* **上游对接:** 从各合资企业(JV)官方网站获取最新的车型视觉资产。
|
||||
* **下游分发:** 通过小红书开放平台 API,将车型内容分发至 C 端用户设备。
|
||||
* **数据回流:** 将在小红书小程序内收集的客户线索(Leads),安全地沉淀至私有云数据库,为奥迪中国后续的营销闭环提供数据支撑。
|
||||
|
||||
### 2.2 用户类与特征 (User Classes)
|
||||
| 用户角色 | 特征描述 | 系统权限 |
|
||||
| :--- | :--- | :--- |
|
||||
| **C端访客** | 浏览小红书的潜在购车用户,对操作流畅度和隐私保护极其敏感。 | 仅限小程序前端的浏览与表单提交操作。 |
|
||||
| **内容运营人员** | 奥迪营销部门或供应商运营专员,负责每周的车型图片更新。 | 门户后台的内容编辑、发布、审核与数据导出。 |
|
||||
| **系统管理员** | 负责系统健康度、用户权限分配及接口监控的 IT 人员。 | 门户后台的最高权限,包含系统配置与日志查看。 |
|
||||
|
||||
### 2.3 运行环境 (Operating Environment)
|
||||
* **前端环境:** 兼容小红书 App 最新版(iOS/Android)的小程序运行沙箱环境。
|
||||
* **后端环境:** 奥迪指定的 Secured Private Cloud(私有云),操作系统建议为基于 Linux 的企业级发行版,需支持 Docker/K8s 等容器化部署以满足高可用需求。
|
||||
|
||||
### 2.4 设计与实现约束 (Constraints)
|
||||
* **合规约束 (PIPL):** 任何涉及用户 PII(个人身份信息)的收集、存储与传输,必须采用强加密手段(如 AES-256),且必须在收集前获取用户显式授权。
|
||||
* **API 速率限制:** 需严格遵守小红书开放平台的接口调用频率限制,避免因频繁同步导致接口被封禁。
|
||||
* **开放性约束 (Openness):** 后端数据结构设计必须解耦,提供标准 RESTful API 或数据导出机制,以防止未来的供应商锁定 (Vendor Lock-in)。
|
||||
|
||||
---
|
||||
|
||||
## 3. 系统特性 (System Features)
|
||||
|
||||
### 3.1 车型库内容管理与同步展示
|
||||
**特性描述:** 系统需要支持从 JV 官网获取最新车型图片,并在小红书小程序前端进行动态展示。
|
||||
|
||||
#### 3.1.1 业务流程交互图
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
autonumber
|
||||
participant Op as 运营人员
|
||||
participant Portal as 第三方门户(Portal)
|
||||
participant JV as JV官网系统接口
|
||||
participant RN as 小红书平台
|
||||
|
||||
Op->>Portal: 发起/配置每周同步任务
|
||||
Portal->>JV: 请求最新车型图片数据 (API)
|
||||
|
||||
alt 正常流程: 获取成功
|
||||
JV-->>Portal: 返回图片数据及元数据
|
||||
Portal->>Portal: 图片格式检查与压缩处理
|
||||
Portal->>RN: 推送更新至小红书小程序
|
||||
RN-->>Portal: 同步成功响应
|
||||
Portal-->>Op: 提示[同步完成]
|
||||
else 异常流程: 接口故障或格式错误
|
||||
JV-->>Portal: 错误响应 / 请求超时
|
||||
Portal-->>Op: 终止同步,触发异常告警
|
||||
end
|
||||
```
|
||||
|
||||
#### 3.1.2 业务规则与流程定义
|
||||
* **正常流程 (Normal Flow):**
|
||||
1. 运营人员登录 Portal,进入“车型库管理”模块。
|
||||
2. 触发或确认系统每周自动执行的“JV官网同步任务”。
|
||||
3. Portal 成功获取数据,校验图片尺寸(需符合小红书UI规范),并推送到前端展示。
|
||||
* **异常流程 (Exception Flow):**
|
||||
* **异常1(网络/接口超时):** 若请求 JV 官网超过 10 秒未响应,重试 3 次;若仍失败,系统记录 Error 日志,并向管理员发送告警邮件,前端继续展示上一版本缓存图片。
|
||||
* **异常2(图片格式不支持):** 若抓取的图片非 WebP/PNG/JPG 格式,或单张大小超过 5MB,系统拦截该图片入库,在 Portal 标记异常条目要求人工介入处理。
|
||||
|
||||
---
|
||||
|
||||
### 3.2 客户线索收集与流转 (Lead Generation)
|
||||
**特性描述:** 允许 C 端用户在小程序中填写联系方式以获取更多购车资讯,系统需安全处理这部分 PII 数据。
|
||||
|
||||
#### 3.2.1 业务流程交互图
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
autonumber
|
||||
participant User as 小红书用户
|
||||
participant MiniApp as 小程序前端
|
||||
participant Portal as 私有云Portal后端
|
||||
|
||||
User->>MiniApp: 浏览车型详情,点击"联系我们"
|
||||
MiniApp->>User: 弹出《个人信息保护授权书》(PIPL)
|
||||
|
||||
alt 正常流程: 用户同意授权
|
||||
User->>MiniApp: 点击同意,填写手机号等留资表单
|
||||
MiniApp->>Portal: [HTTPS] 提交加密表单数据
|
||||
Portal->>Portal: 数据完整性校验 & 敏感字段落库加密
|
||||
Portal-->>MiniApp: 返回提交成功状态
|
||||
MiniApp-->>User: 展示"提交成功,我们将尽快联系您"视图
|
||||
else 异常流程 A: 拒绝授权
|
||||
User->>MiniApp: 点击拒绝
|
||||
MiniApp-->>User: 阻断表单填写,返回上一页
|
||||
else 异常流程 B: 后端校验失败
|
||||
Portal-->>MiniApp: 返回校验错误(如手机号格式错误)
|
||||
MiniApp-->>User: 提示修改错误字段
|
||||
end
|
||||
```
|
||||
|
||||
#### 3.2.2 业务规则与流程定义
|
||||
* **正常流程 (Normal Flow):**
|
||||
1. 用户必须先通过 PIPL 协议的弹窗授权(勾选或点击同意)。
|
||||
2. 提交包含必填项(如姓名、手机号、意向车型)的表单。
|
||||
3. Portal 后端接收到数据后,对“手机号”进行加密存储,并将该条留资状态标记为“未处理”。
|
||||
* **异常流程 (Exception Flow):**
|
||||
* **异常1(拒绝授权):** 强阻断。未授权 PIPL 的用户绝对不允许进行任何表单输入操作。
|
||||
* **异常2(数据库写入失败):** 若由于私有云数据库故障导致无法落库,前端提示“系统繁忙,请稍后再试”,同时触发 Critical 级别的系统内部告警。
|
||||
|
||||
---
|
||||
|
||||
### 3.3 第三方门户配置与维护 (3rd Party Portal Admin)
|
||||
**特性描述:** 提供一个后台管理界面,确保小红书小程序的内容高可用,并支持按需调整。
|
||||
|
||||
* **业务规则:**
|
||||
1. **所见即所得 (WYSIWYG):** 运营人员可以在后台编辑车型介绍文本,并能预览在小程序上的实际展示效果。
|
||||
2. **API 状态监控:** Portal 仪表盘需实时展示与小红书后端及 JV 官网接口的连通性状态(绿/黄/红灯)。
|
||||
3. **数据隔离:** 留资数据的查看与导出需具备独立的权限管控,禁止普通运营人员全量导出用户隐私数据,导出操作需记录系统审计日志 (Audit Log)。
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
# 奥迪小红书小程序门户 - 需求规格说明书 (SRS) - Part 2
|
||||
|
||||
## 4. 外部接口需求 (External Interface Requirements)
|
||||
|
||||
### 4.1 用户界面 (User Interfaces)
|
||||
|
||||
#### 4.1.1 小红书小程序前端 UI 状态机
|
||||
前端界面必须严格遵循奥迪中国品牌视觉规范(VI)以及小红书小程序的设计规范。以下是核心的“留资(Lead Generation)”交互状态机:
|
||||
|
||||
```mermaid
|
||||
stateDiagram-v2
|
||||
[*] --> 车型列表页
|
||||
车型列表页 --> 车型详情页 : 点击车型
|
||||
车型详情页 --> 留资表单页 : 点击[获取底价/预约试驾]
|
||||
留资表单页 --> PIPL授权弹窗 : 页面加载时或提交前拦截
|
||||
|
||||
PIPL授权弹窗 --> 留资表单页 : 用户[同意]
|
||||
PIPL授权弹窗 --> 车型详情页 : 用户[拒绝] (操作阻断)
|
||||
|
||||
留资表单页 --> 数据校验中 : 点击[提交]
|
||||
数据校验中 --> 提交成功页 : 校验通过 & 后端落库成功
|
||||
数据校验中 --> 留资表单页 : 校验失败 (提示具体字段错误)
|
||||
|
||||
提交成功页 --> [*] : 返回首页/关闭
|
||||
```
|
||||
|
||||
#### 4.1.2 第三方门户(后台)UI 规范
|
||||
* **响应式设计:** 必须支持主流桌面浏览器(Chrome, Edge, Safari),分辨率适配 1920x1080 及以上。
|
||||
* **数据脱敏展示:** 运营人员在后台查看留资列表时,涉及个人隐私(如手机号)的字段必须默认以脱敏形式(Masking)展示(例如:`138****1234`),仅拥有特定高级权限的管理员方可查看或导出明文。
|
||||
|
||||
### 4.2 软件接口 (Software Interfaces)
|
||||
|
||||
系统需通过标准化的 API 实现内部平台与外部数据源的对接,满足 RFP 对“开放性 (Openness)”的要求。
|
||||
|
||||
| 接口名称 | 调用方向 | 协议/架构 | 核心功能描述 | 异常处理机制 |
|
||||
| :--- | :--- | :--- | :--- | :--- |
|
||||
| **JV 官网图片同步 API** | Portal -> JV官网 | RESTful GET | 获取合资公司官网最新车型库的图片链接及元数据。 | 超时重试 3 次,失败则触发系统告警。 |
|
||||
| **小红书内容下发 API** | Portal -> 小红书开放平台 | RESTful POST | 将编辑好的页面结构与内容推送到小程序端。 | 依据小红书 API 返回的 Error Code 进行针对性记录与重发。 |
|
||||
| **留资数据导出 API** | 外部CRM -> Portal | RESTful GET | 提供标准开放接口,支持奥迪其他业务系统(如 CRM)拉取线索数据。 | 强身份鉴权,基于 Token 限制调用频率。 |
|
||||
|
||||
### 4.3 通信接口 (Communications Interfaces)
|
||||
* **传输加密:** 所有内外网通信必须基于 HTTPS 协议,采用 TLS 1.2 或更高版本进行加密。
|
||||
* **接口鉴权:** * 针对内部后台管理,采用 JWT (JSON Web Token) 进行会话管理。
|
||||
* 针对外部 API 调用,采用基于 OAuth 2.0 的授权机制或高强度的 API Key + Secret 签名校验。
|
||||
|
||||
---
|
||||
|
||||
## 5. 非功能性需求 (Nonfunctional Requirements)
|
||||
|
||||
### 5.1 性能与服务可用性需求 (Performance & SLA)
|
||||
|
||||
根据 RFP 规定,项目进入运维阶段后必须满足以下服务水平协议(SLA):
|
||||
|
||||
* **系统可用性 (Availability):** 核心服务可用性需达到 99.9%。
|
||||
* **服务时间 (Service Hours):**
|
||||
* **常规支持 (Service Hours):** 周一至周五 08:30 - 17:30。
|
||||
* **待命支持 (Stand-by Hours):** 周一至周五 17:30 - 次日 08:30;周末及法定节假日 00:00 - 24:00。
|
||||
* **响应与解决指标 (Critical & High Priority):**
|
||||
* **响应时间 (Response Time):** 任何 Critical/High 级别的系统故障,在接收到告警后,支持团队必须在 **15 分钟** 内响应。
|
||||
* **解决时间 (Resolution Time):** 必须在 **4 小时** 内提供临时解决方案(Workaround)或彻底修复,并提交事件分析报告。
|
||||
|
||||
### 5.2 安全、隐私与合规需求 (Security & Privacy)
|
||||
|
||||
针对 RFP 中强调的 **Data Loss** 和合规风险,制定以下策略:
|
||||
|
||||
* **数据保留与备份 (Backup & Retention):**
|
||||
* 数据库需执行**每日增量备份**与**每周全量备份**。
|
||||
* 根据 RFP 强制要求,源环境备份数据必须保留**至少 1 个月(≥ 1 month)**。
|
||||
* 备份文件必须进行加密处理,并存储在异地或隔离的私有云存储桶中。
|
||||
* **PIPL 个人信息保护合规:**
|
||||
* **存储加密:** 数据库中涉及客户 PII(个人身份信息)的字段(如姓名、手机号)必须使用 AES-256 对称加密算法存储(Data at Rest Encryption)。
|
||||
* **审计日志:** 所有涉及敏感数据导出的操作,必须记录不可篡改的审计日志(包含操作人、时间、IP、导出条数)。
|
||||
|
||||
### 5.3 可维护性与容灾需求 (Maintainability & Contingency)
|
||||
|
||||
针对 RFP 中提出的 **Performance Degradation**, **Integration Failure**, 和 **Contingency Planning** 风险:
|
||||
|
||||
* **全链路监控体系:** 部署系统级监控(如 CPU、内存、磁盘 I/O)与应用级监控(接口响应耗时、错误率)。当性能指标超过阈值(如 API 响应时间 > 3秒)时,自动通过邮件/短信通知运维人员。
|
||||
* **性能降级预案:** 当小红书并发访问量激增导致私有云后端过载时,系统应具备“服务降级”能力,如暂停非核心的 JV 官网同步任务,优先保障留资接口的吞吐量。
|
||||
* **回滚机制 (Rollback):** 任何生产环境的发布必须配备详细的回滚 SOP。若发布后发生重大缺陷,系统必须能够在 **30 分钟** 内恢复到上一个稳定版本(可通过虚拟机快照或蓝绿部署实现)。
|
||||
|
||||
### 5.4 可重用性与开放性 (Reusability & Openness)
|
||||
* **技术资产重用:** 系统架构应采用前后端分离的微服务设计理念。底层服务组件(如短信通知模块、日志模块)应封装为通用库,以便在奥迪未来的其他 IT 项目中复用。
|
||||
* **平台防绑定 (No Vendor Lock-in):** 前端采用标准框架,后端数据模型需结构化。若未来发生平台迁移,系统确保能够一键导出所有的图片资源包与关系型数据(CSV/SQL 格式),且开放接口可平滑切换路由至新平台。
|
||||
|
||||
---
|
||||
|
||||
## 6. 附录 (Appendix)
|
||||
|
||||
### 6.1 业务规则列表 (Business Rules)
|
||||
* **BR-001 [合规阻断]:** 未同意《隐私政策》与 PIPL 授权条款的用户,不得激活留资表单的提交按钮。
|
||||
* **BR-002 [内容准入]:** 运营人员上传或自动同步的车型图片,单张体积不得超过 5MB,且必须通过系统自带的敏感词与违规图像(AI)初步筛查后,方可推送到前端。
|
||||
* **BR-003 [运维汇报]:** 每月首个工作日必须向奥迪中国提交上月《月度运营报告(Monthly Operation Report)》。
|
||||
|
||||
### 6.2 待确定问题 (TBD List)
|
||||
*(注:以下问题需要在方案设计阶段或项目启动会(Kick-off)上与奥迪方进一步明确)*
|
||||
|
||||
1. **私有云环境边界:** 奥迪中国提供的“Secured private cloud”具体是基于哪种底层架构(如 VMWare、特定的厂商云),是否允许使用容器化(Docker/K8s)部署?
|
||||
2. **JV 接口协议:** 合资企业官网目前是否已经具备标准的、开箱即用的 RESTful API 供本项目调用?如果不具备,是否需要本项目团队进行网页数据抓取(Scraping)?
|
||||
3. **第三方平台选型:** RFP 中提到的“3rd party platform”,客户是否有预期的偏好名单,还是完全由供应商进行选型推荐?
|
||||
|
||||
---
|
||||
Reference in New Issue
Block a user