Add under-anything knowledge dashboard
This commit is contained in:
44
wishfulfilled-wiki/07_技术文档/README.md
Normal file
44
wishfulfilled-wiki/07_技术文档/README.md
Normal file
@@ -0,0 +1,44 @@
|
||||
---
|
||||
type: technical_docs_home
|
||||
tags: [技术文档, 架构, 开发, 知识库]
|
||||
aliases: [技术文档入口, 技术资料]
|
||||
source: manual
|
||||
status: active
|
||||
owner: 技术负责人
|
||||
updated: 2026-05
|
||||
---
|
||||
|
||||
# 技术文档
|
||||
|
||||
本目录用于存放系统架构、数据模型、接口说明、实现方案、部署说明和技术决策记录。
|
||||
|
||||
## 二级入口
|
||||
|
||||
- [[技术文档索引]]
|
||||
- [[系统架构说明模板]]
|
||||
- [[接口说明模板]]
|
||||
- [[技术决策记录]]
|
||||
|
||||
## 存放内容
|
||||
|
||||
- 系统架构说明
|
||||
- 模块设计说明
|
||||
- 数据表/业务对象设计
|
||||
- API 接口说明
|
||||
- 权限与安全设计
|
||||
- 部署与配置说明
|
||||
- 技术决策记录
|
||||
|
||||
## 命名建议
|
||||
|
||||
```text
|
||||
系统或模块_技术方案_YYYYMMDD.md
|
||||
系统或模块_接口说明_YYYYMMDD.md
|
||||
系统或模块_数据模型_YYYYMMDD.md
|
||||
```
|
||||
|
||||
## 关联目录
|
||||
|
||||
- 需求依据:[[../05_需求文档/README|需求文档]]
|
||||
- 测试依据:[[../08_测试相关/README|测试相关]]
|
||||
- 里程碑:[[../06_里程碑/README|里程碑]]
|
||||
15
wishfulfilled-wiki/07_技术文档/技术决策记录.md
Normal file
15
wishfulfilled-wiki/07_技术文档/技术决策记录.md
Normal file
@@ -0,0 +1,15 @@
|
||||
---
|
||||
type: adr_log
|
||||
tags: [技术文档, 技术决策, ADR]
|
||||
aliases: [技术决策, ADR]
|
||||
source: manual
|
||||
status: active
|
||||
owner: 技术负责人
|
||||
updated: 2026-05
|
||||
---
|
||||
|
||||
# 技术决策记录
|
||||
|
||||
| 日期 | 决策主题 | 背景 | 决策结论 | 影响范围 | 关联需求/技术文档 |
|
||||
|---|---|---|---|---|---|
|
||||
| | | | | | |
|
||||
29
wishfulfilled-wiki/07_技术文档/技术文档索引.md
Normal file
29
wishfulfilled-wiki/07_技术文档/技术文档索引.md
Normal file
@@ -0,0 +1,29 @@
|
||||
---
|
||||
type: technical_docs_index
|
||||
tags: [技术文档, 索引, Agent检索]
|
||||
aliases: [技术索引, 技术资料清单]
|
||||
source: manual
|
||||
status: active
|
||||
owner: 技术负责人
|
||||
updated: 2026-05
|
||||
---
|
||||
|
||||
# 技术文档索引
|
||||
|
||||
## 技术文档清单
|
||||
|
||||
| 模块/系统 | 文档类型 | 文件 | 关联需求 | 负责人 | 更新时间 | 状态 |
|
||||
|---|---|---|---|---|---|---|
|
||||
| | | | | | | |
|
||||
|
||||
## Agent 检索关键词
|
||||
|
||||
| 问法 | 标准术语 | 命中文件 | 答案要点 |
|
||||
|---|---|---|---|
|
||||
| | | | |
|
||||
|
||||
## 维护规则
|
||||
|
||||
- 新增技术方案、接口说明、数据模型后,在本索引登记。
|
||||
- 技术文档必须关联需求文档或业务流程。
|
||||
- Agent 回答技术实现、接口、数据结构问题时,应优先检索本目录。
|
||||
51
wishfulfilled-wiki/07_技术文档/接口说明模板.md
Normal file
51
wishfulfilled-wiki/07_技术文档/接口说明模板.md
Normal file
@@ -0,0 +1,51 @@
|
||||
---
|
||||
type: api_template
|
||||
tags: [技术文档, 接口, 模板]
|
||||
aliases: [接口模板, API说明模板]
|
||||
source: manual
|
||||
status: active
|
||||
owner: 技术负责人
|
||||
updated: 2026-05
|
||||
---
|
||||
|
||||
# 接口说明模板
|
||||
|
||||
## 基本信息
|
||||
|
||||
| 项目 | 内容 |
|
||||
|---|---|
|
||||
| 接口名称 | |
|
||||
| 所属模块 | |
|
||||
| 关联需求 | |
|
||||
| 负责人 | |
|
||||
| 状态 | draft |
|
||||
|
||||
## 接口用途
|
||||
|
||||
|
||||
## 请求说明
|
||||
|
||||
| 字段 | 类型 | 必填 | 说明 | 示例 |
|
||||
|---|---|---|---|---|
|
||||
| | | | | |
|
||||
|
||||
## 响应说明
|
||||
|
||||
| 字段 | 类型 | 说明 | 示例 |
|
||||
|---|---|---|---|
|
||||
| | | | |
|
||||
|
||||
## 业务规则
|
||||
|
||||
|
||||
## 异常码
|
||||
|
||||
| 异常码 | 含义 | 处理方式 |
|
||||
|---|---|---|
|
||||
| | | |
|
||||
|
||||
## Agent 检索字段
|
||||
|
||||
- 关键词:
|
||||
- 同义词:
|
||||
- 典型问法:
|
||||
53
wishfulfilled-wiki/07_技术文档/系统架构说明模板.md
Normal file
53
wishfulfilled-wiki/07_技术文档/系统架构说明模板.md
Normal file
@@ -0,0 +1,53 @@
|
||||
---
|
||||
type: architecture_template
|
||||
tags: [技术文档, 架构, 模板]
|
||||
aliases: [架构说明模板]
|
||||
source: manual
|
||||
status: active
|
||||
owner: 技术负责人
|
||||
updated: 2026-05
|
||||
---
|
||||
|
||||
# 系统架构说明模板
|
||||
|
||||
## 基本信息
|
||||
|
||||
| 项目 | 内容 |
|
||||
|---|---|
|
||||
| 系统/模块 | |
|
||||
| 关联需求 | |
|
||||
| 负责人 | |
|
||||
| 状态 | draft |
|
||||
|
||||
## 背景与目标
|
||||
|
||||
|
||||
## 架构说明
|
||||
|
||||
|
||||
## 模块划分
|
||||
|
||||
| 模块 | 职责 | 输入 | 输出 | 依赖 |
|
||||
|---|---|---|---|---|
|
||||
| | | | | |
|
||||
|
||||
## 数据模型
|
||||
|
||||
|
||||
## 接口关系
|
||||
|
||||
|
||||
## 权限与安全
|
||||
|
||||
|
||||
## 异常与边界
|
||||
|
||||
|
||||
## 部署与配置
|
||||
|
||||
|
||||
## Agent 检索字段
|
||||
|
||||
- 关键词:
|
||||
- 同义词:
|
||||
- 典型问法:
|
||||
Reference in New Issue
Block a user