46 lines
1.7 KiB
Markdown
46 lines
1.7 KiB
Markdown
# README 文档同步 PRD
|
|
|
|
- 功能编号：FEAT-MO-003
|
|
- PRD版本：0.1
|
|
- 状态：approved
|
|
- 日期：2026-08-19
|
|
|
|
## 背景与问题
|
|
|
|
根目录 README 仍使用旧的英文项目描述、旧的 5173 前端端口和过时的基础设施说明，无法指导当前 TDX 双隧道开发。
|
|
|
|
## 产品目标
|
|
|
|
- README 准确说明当前市场概览首屏能力和未覆盖的数据源边界。
|
|
- README 准确说明 Vue/NestJS/TDX/MySQL/Redis/RocketMQ 技术栈和源码部署边界。
|
|
- README 准确说明 8888 Web、3000 API、17710 TDX 回环入口和 Tailscale 外部场景。
|
|
- README 提供可直接执行的本地启动、验证和治理入口。
|
|
|
|
## 非目标
|
|
|
|
- 不改变业务代码、接口、运行配置或生产部署。
|
|
- 不把真实 Tailscale 地址、Windows 用户、Token、密码或私钥写入文档。
|
|
|
|
## 功能需求
|
|
|
|
| 编号 | 优先级 | 需求 | 可观察结果 |
|
|
|---|---|---|---|
|
|
| FR-001 | P0 | 更新当前实现和技术栈 | README 与 FEAT-MO-001、架构文档一致 |
|
|
| FR-002 | P0 | 更新本地端口和启动命令 | README 使用 Web 8888、API 3000 |
|
|
| FR-003 | P0 | 更新 TDX 双隧道说明 | README 只使用 SSH 别名和 127.0.0.1:17710 |
|
|
| FR-004 | P1 | 更新验证入口 | Schema、治理、测试和部署文档可追溯 |
|
|
|
|
## 安全策略与评估
|
|
|
|
README 只记录占位符和回环地址，不记录凭据；明确 TDX 不暴露到公网，明确 Schema 只能访问开发库。
|
|
|
|
## 性能目标与评估
|
|
|
|
文档不进入运行时路径，不增加 API、TDX、Redis、MySQL 或 RocketMQ 负载。
|
|
|
|
## 验收标准
|
|
|
|
- README 不再把 5173 描述为当前 Web 端口。
|
|
- README 包含 8888、TDX 外部隧道和当前首屏模块。
|
|
- README 命令与现有 package scripts 和部署手册一致。
|