wurenzhi
136c2fa579
- 新增文档模板和导航结构 - 实现服务器基础API路由和控制器 - 添加扩展插件配置和前端框架 - 引入多租户和权限管理模块 - 集成日志和数据库配置 - 添加核心业务模型和类型定义
45 lines
1.5 KiB
Markdown
45 lines
1.5 KiB
Markdown
# 💎 Quality & Optimization (Crawlful Hub)
|
||
|
||
> **定位**：Crawlful Hub 质量保障与内容优化 - 包含前端交付标准、UX 检查清单及文档内容分析报告。
|
||
> **更新日期**: 2026-03-17
|
||
|
||
---
|
||
|
||
## 1. 前端交付质量标准 (Frontend Delivery)
|
||
|
||
### 1.1 UI/UX 规范
|
||
- **框架**: UmiJS 4.x, Ant Design 5.x.
|
||
- **交互模式**: 业务审核工作流 (Business-Review-Workflow).
|
||
- **Red Lines (严禁事项)**: 严禁 Mock 数据、严禁越权修改、严禁敏感数据暴露。
|
||
|
||
### 1.2 性能优化
|
||
- **加载**: Code Splitting, Lazy Loading.
|
||
- **请求**: TanStack Query 缓存, 减少重渲染.
|
||
|
||
---
|
||
|
||
## 2. 用户体验检查清单 (UX Checklist)
|
||
|
||
### 2.1 加载与响应
|
||
- [ ] 异步操作展示 Loading 状态。
|
||
- [ ] 长时操作展示进度。
|
||
- [ ] 按钮点击反馈即时。
|
||
|
||
### 2.2 错误与异常
|
||
- [ ] 4xx 错误展示具体根因分析，而非模糊的“系统错误”。
|
||
- [ ] 5xx 错误展示友好提示并记录 `traceId`。
|
||
|
||
---
|
||
|
||
## 3. 文档内容分析报告 (Document Review)
|
||
|
||
### 3.1 质量与优化
|
||
- **命名规范**: 文件名必须使用小写短横线 (kebab-case)。
|
||
- **分类存放**: `docs/blueprints/`, `docs/quality/` 等。
|
||
- **引用闭环**: 文档内引用必须使用完整 Markdown 链接。
|
||
- **原子化更新**: 每次功能变更必须同步更新对应蓝图。
|
||
|
||
### 3.2 文档地图
|
||
- 建议维护 `doc-index.md` 索引，确保全量文档导航。
|
||
- 定期审查文档结构，确保与物理文件系统保持一致。
|