docs: 初始化如愿知识库

This commit is contained in:
qiaoxinjiu
2026-05-26 15:08:20 +08:00
commit 0e85cb0d10
59 changed files with 4371 additions and 0 deletions

78
05_需求文档/README.md Normal file
View File

@@ -0,0 +1,78 @@
---
type: requirement_inbox
tags: [需求文档, 需求收集, 知识库更新, Agent]
aliases: [需求文档目录, 需求收集目录, 需求入口]
source: manual
status: active
owner: 产品经理 / 业务主管
updated: 2026-05
---
# 需求文档
本目录用于集中存放后续持续补充的业务需求文档、业务规则文档、流程补充文档和需求变更文档。
## 使用方式
1. 所有新增需求文档优先放入本目录。
2. 建议使用 `03_规范与模板/需求说明模板.md``03_规范与模板/业务规则与需求补充模板.md` 创建文档。
3. 文档确认有效后,同步更新业务流程索引和 Agent 检索索引。
4. Agent 回答具体业务需求时,应优先检索本目录。
## 推荐命名
```text
业务域_需求或规则名称_YYYYMMDD.md
```
示例:
```text
采购_供应商准入规则_20260526.md
库存_出入库审批规则_20260526.md
销售_客户授信额度需求_20260526.md
```
## 文档状态
每个需求文档建议在 Frontmatter 中维护 `status`
| 状态 | 含义 |
|---|---|
| draft | 草稿,尚未确认 |
| reviewing | 评审中 |
| active | 已确认,可作为 Agent 回答依据 |
| deprecated | 已废弃,仅归档参考 |
## 必填内容
每个需求文档至少包含:
- 需求背景
- 适用范围
- 涉及角色
- 业务规则
- 业务流程
- 异常处理
- 权限要求
- 验收口径
- Agent 检索字段
- 变更记录
## 索引维护
新增或修改需求文档后,需要同步更新:
- `05_需求文档/需求文档索引.md`
- `01_业务流程/业务规则索引.md`
- `01_业务流程/业务对象字典.md`
- `04_Agent检索/关键词索引.md`
- `04_Agent检索/同义词表.md`
- `04_Agent检索/来源文件索引.md`
## 验证流程
新增需求文档后,按 `04_Agent检索/知识库持续更新与验证流程.md` 执行验证,并将验证结果记录到:
- `05_需求文档/需求文档索引.md`
- `01_业务流程/业务补充验证记录.md`

View File

@@ -0,0 +1,39 @@
---
type: requirement_index
tags: [需求文档, 索引, Agent检索]
aliases: [需求索引, 需求文档清单, 需求清单]
source: manual
status: active
owner: 产品经理 / 业务主管
updated: 2026-05
---
# 需求文档索引
本文件记录 `05_需求文档/` 下所有正式需求文档,供人工维护和 Agent 检索定位。
## 需求文档清单
| 编号 | 业务域 | 需求/规则名称 | 文件 | 状态 | 负责人 | 更新时间 | 验证状态 |
|---|---|---|---|---|---|---|---|
| | | | | | | | 未验证 |
## Agent 检索关键词
| 关键词/问法 | 标准术语 | 命中文件 | 答案要点 |
|---|---|---|---|
| | | | |
## 维护规则
1. 新增需求文档后,必须在“需求文档清单”新增一行。
2. 每个需求文档至少维护 3 个可检索问法。
3. `状态=active` 的文档可作为 Agent 回答依据。
4. `status=draft/reviewing` 的文档只能作为草稿参考Agent 回答时需说明尚未确认。
5. `status=deprecated` 的文档不得作为当前规则依据,只能说明历史背景。
## 验证记录摘要
| 日期 | 文件 | 验证问题数 | 通过数 | 失败数 | 结论 |
|---|---|---:|---:|---:|---|
| | | | | | |