# 易标手册项目约定

## 默认位置

- 优先把包含 `client/开发说明.md` 的当前仓库作为项目根目录。
- 当前机器的已知项目位置为 `D:\CodeSpace\SelfSpace\yibiao-simple`，仅在当前工作目录无法定位仓库时使用。
- 当前机器的已知发行版位置为 `C:\Users\Administrator\AppData\Local\Programs\yibiao-client\易标投标工具箱.exe`。
- 使用已知发行版前检查文件存在并确认 `VersionInfo.ProductName` 等于“易标投标工具箱”。路径失效或无法确定时询问用户，不搜索并猜测其他 EXE，也不启动开发版。
- 手册根目录为 `<项目根目录>\使用说明`。

## 使用说明权威来源

按以下顺序核对功能：

1. 仓库及上级 `AGENTS.md` 与 `client/开发说明.md`。
2. `client/src/app/menuConfig.ts`、`AppRouter.tsx` 和目标 `client/src/features/<feature>/` 页面。
3. 当前发行版真实界面和已有数据。

代码与发行版不一致时，以发行版用户实际可见行为为手册依据。菜单或页面出现“正在开发中”、禁用操作或开发者模式入口时不写入普通用户手册。

## 版本日志权威来源

按以下顺序分析正式版本变化：

1. `scripts/changelog_tool.py inspect --json` 验证的本地正式 `v2.*` Git 标签、相邻版本提交和变更文件。
2. 相邻标签之间的代码差异、用户可见文案和功能入口。
3. 已有 `v2版本更新日志.md` 的版本边界、术语、格式和文风。

提交标题只用于发现候选变化，不直接复制到日志。没有完整历史、缺少基线标签或版本对应关系不明确时停止并询问，不根据当前工作区未发布代码补写正式日志。

## 服务器发布范围

- 服务器发布是本地文档任务之后的独立确认阶段，也可以作为“仅同步”任务单独执行。
- 默认只比较本次目标 Markdown、所需文件夹和引用图片，不把工作区其他变化带入发布计划。
- 更新完整使用说明但不更新版本日志时，显式枚举“配置”和“使用”目录的 Markdown；只有用户明确选择“全部更新”或完整目录同步时才使用完整目录范围。
- 本地生成和服务器发布都不得从“版本升级”推断为完整使用说明更新。用户未说明任务或范围时先询问。

## 范围映射

| 用户描述 | 目标 Markdown | 当前截图 |
| --- | --- | --- |
| 文本模型配置 | `配置/01-配置文本模型.md` | `02-设置页签.png`、`03-文本模型配置.png` |
| 生图模型配置 | `配置/02-配置生图模型.md` | `04-生图模型配置.png` |
| 文件解析 | `配置/03-选择文件解析方式.md` | `05-文件解析配置.png` |
| 智能体配置 | `配置/04-智能体配置.md` | `06-智能体配置.png` |
| 生成技术方案 | `使用/01-生成技术方案.md` | `07` 至 `11` 对应五步流程 |
| 已有方案扩写 | `使用/02-已有方案扩写.md` | 按发行版现状决定 |
| 文档知识库 | `使用/03-使用文档知识库.md` | `12-文档知识库.png` |
| 标书查重 | `使用/04-标书查重.md` | `13-标书查重选择文件.png`、`14-标书查重结果.png` |
| 废标项检查 | `使用/05-废标项检查.md` | `15-废标项检查结果.png` |
| 常见问题 | `使用/06-常见问题.md` | 通常不需要截图 |
| v2 版本更新日志 | `更新日志/v2版本更新日志.md` | 不需要截图 |

新增功能时沿用编号前缀并只在发行版确认完成后新增章节。不要为了保持旧编号连续而重命名范围外文件。

## 文档结构

```text
使用说明/
├── 更新日志/
│   └── v2版本更新日志.md
├── 配置/
│   └── NN-功能名.md
├── 使用/
│   └── NN-功能名.md
└── images/
    ├── NN-页面名.png
    └── 标注/
        └── NN-页面名.png
```

- 版本日志固定放在 `更新日志/v2版本更新日志.md`，与服务器“更新日志”文件夹保持一致。
- 手册根目录不建立 README 或总索引。
- 使用说明 Markdown 只引用 `../images/标注/` 下的截图。
- 原图与标注图使用相同文件名和尺寸。
- 不写上一篇、下一篇、返回总目录或开始使用链接。

## 数据门槛和禁止操作

以下约束只适用于使用说明任务，版本日志任务不启动发行版、不检查业务数据：

- 技术方案需要目标步骤已有导入、解析、目录、事实或正文结果。
- 知识库需要至少有目标文件夹和已处理文档。
- 查重和废标项检查需要已有文件及检查结果。
- 不点击开始/重新生成、重新解析、测试、自检、重新检查、删除、导出等可能改变数据或耗时的操作。
- 没有数据时告诉用户需要自行完成的具体流程，然后停止；用户再次调用后重新检查。
