# offerAI

**Repository Path**: null_089_9533/offer-ai

## Basic Information

- **Project Name**: offerAI
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-03
- **Last Updated**: 2026-04-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Offer信息站（OfferAI）顶层设计与文档总览

求职信息聚合与会员服务 Web 产品，包含校招信息表、事业编/国企信息表、面试资料售卖及投递管理。

本目录 `topdesign/` 作为**产品与技术的顶层设计入口**，串起蓝图、功能清单、PRD 与技术设计文档。

---

## 1. 仓库整体结构（当前版本）

```text
xiaoy/
├── topdesign/                       # 顶层设计与产品文档入口（本目录）
│   ├── README.md                    # 总览与导航（当前文件）
│   ├── 01_blueprint.md              # 产品蓝图与场景说明（V1）
│   ├── 02_featureList .md           # Feature List（功能清单，含编号与优先级）
│   └── product-doc-standard/
│       └── README.md                # 产品文档结构标准（DOC_ROOT、命名规范等）
│
├── prd/                             # 按模块拆分的 PRD 文档
│   ├── README.md                    # PRD 撰写规范与索引
│   ├── backend/                     # 后台管理 PRD（列表、表单、字典等）
│   │   └── README.md                # 后台 PRD 索引与 UI 规范
│   └── frontend/                    # 前台/工作台 PRD（如有）
│
└── tech/                            # 技术设计文档（开发实现方案）
    ├── README.md                    # 技术文档清单与索引
    ├── 01_技术栈与架构.md
    ├── 02_数据模型与存储.md
    ├── 03_接口与鉴权.md
    ├── 04_支付与权益发放.md
    ├── 05_业务模块实现要点.md
    └── 06_开发环境与联调约定.md
```

> 说明：原先分散在根目录的 ER 图、时序图等 `.mmd/.md` 文件，已逐步内联/归并到蓝图与技术文档中，避免多处维护。

---

## 2. 顶层设计文档说明（topdesign）

- **`01_blueprint.md` – 产品蓝图与场景说明**
  - 定义版本范围、用户角色、关键场景（SCN-xx）与能力地图（领域 → 模块 → 能力）。
  - 内联了：
    - ER 图的 Mermaid 源码；
    - 关键时序图（校招信息表浏览与解锁、飞书同步）的 Mermaid 源码。
  - 是 Feature List、PRD 与技术设计的**统一上游**。

- **`02_featureList .md` – Feature List（功能清单）**
  - 以表格形式列出模块、功能点、优先级（Must/Should/Nice to have）。
  - 编号体系（如 `1.1.1`、`2.2.3`）与蓝图中的能力节点、PRD 文档 Header 对齐。

- **`product-doc-standard/README.md` – 产品文档结构标准**
  - 约定 DOC_ROOT、蓝图/Feature List/PRD/技术文档的路径与命名规范。
  - 指南类文档，供后续扩展新模块、新版本时参考。

---

## 3. 与 PRD / 技术设计的关系

| 文档类型          | 位置           | 作用                                                         |
|-------------------|----------------|--------------------------------------------------------------|
| 蓝图（Blueprint） | `01_blueprint` | 定义场景 ID、能力地图，是 Feature List / PRD / Tech 的上游   |
| Feature List      | `02_featureList` | 功能范围、优先级与编号；PRD Header 必须引用对应编号          |
| PRD               | `../prd/`      | 具体页面与流程规格，按模块拆分；Header 需写明场景/编号/ER/时序 |
| 技术设计          | `../tech/`     | 技术栈、数据模型、接口与鉴权、支付与权益、模块实现要点等     |

使用建议：

1. **新功能 / 新版本规划**：先在 `01_blueprint.md` 中补充场景与能力，再更新 `02_featureList .md`。
2. **撰写或更新 PRD**：在 `prd/` 下对应模块中新建/编辑文件，并在 Header 中引用：
   - 对应 Feature List 编号；
   - 对应蓝图场景 ID（SCN-xx）；
   - 相关 ER 实体与时序图编号（如有）。
3. **技术实现**：在 `tech/` 中补充或更新相应章节，保持与蓝图、Feature List 与 PRD 一致。

---

## 4. 后台管理 UI 约定（与 PRD 对齐）

- **布局**：典型中后台风格，**左侧固定导航菜单 + 右侧主内容区**。
- **主内容区**：
  - 列表页：顶部筛选区 + 表格 + 分页；
  - 详情/编辑：表单卡片或抽屉。
- **UI 细节**：按钮文案、表格字段、筛选项与交互规范以各模块 PRD 为准，汇总见 `prd/backend/README.md`。