a27e3b8e43
Optimized the root .gitignore to exclude virtual environments, node modules, and temp folders to ensure clean and lightweight version tracking. Co-authored-by: Cursor <cursoragent@cursor.com>
40 lines
954 B
Markdown
40 lines
954 B
Markdown
# 网页文档生成规则
|
|
|
|
用于生成网页资产相关文档。
|
|
不负责主题 token 提取与数据建模细节。
|
|
|
|
## 文档类型
|
|
|
|
默认产物：
|
|
- `src/docs/page-map.md`
|
|
- `src/docs/project-overview.md`
|
|
|
|
用户明确要求时可追加：
|
|
- 领域模型、关系模型、流程模型、状态模型、权限模型
|
|
|
|
## 页面地图规范
|
|
|
|
1. 按模块或业务流分组链接。
|
|
2. 页面名称必须可点击并指向 URL。
|
|
3. 每个页面附简短用途说明。
|
|
|
|
## 项目概览规范
|
|
|
|
至少包含：
|
|
- 项目定位与核心目标
|
|
- 页面规模与功能模块
|
|
- 主题风格摘要（引用主题产物）
|
|
- 数据模型摘要（引用数据文件）
|
|
|
|
## 业务文档规范
|
|
|
|
1. 明确边界与对象定义。
|
|
2. 优先结构化表达（表格/分层清单）。
|
|
3. 对不确定项显式标记“待确认”。
|
|
|
|
## 质量检查
|
|
|
|
- 文件落在 `src/docs/`
|
|
- 命名使用 kebab-case
|
|
- 内容与已抓取页面一致，不杜撰关键流程
|