Skip to content

Wiki 目录规范

本文档约束 wiki/ 目录的内容组织方式。目标是让知识库既能直接用 Markdown 阅读,也能被后续 Web 系统稳定读取和展示。

1、基本原则

wiki/ 是知识库源内容目录,包含:

  • Markdown 文档
  • 截图
  • 图表
  • 后续可能补充的附件

Web 系统只读取和展示 wiki/,不把业务正文复制到 web/

中文源内容维护在 wiki/cn/,英文学习版维护在 wiki/en/。二者使用同路径结构,不直接在 web/wiki/cn/ 维护生成后的内容。

2、推荐结构

text
wiki/
├── cn/
└── en/

中文源内容结构:

text
wiki/cn/
├── README.md
├── 00-总览/
├── 01-存款核心/
├── 02-贷款核心/
├── 03-通用核心能力/
└── assets/

英文学习版对应结构:

text
wiki/en/
├── index.md
├── README.md
├── 00-总览/
├── 01-存款核心/
├── 02-贷款核心/
└── 03-通用核心能力/

除英文站点首页 wiki/en/index.md 外,wiki/cn/ 下每个 Markdown 都应有 wiki/en/ 同路径英文页。英文页可复用 Web 中的中文截图路径,不需要复制图片。

3、内容目录

目录用途
cn/00-总览/学习路线、系统地图、术语表、待补充清单。
cn/01-存款核心/存款核心相关知识,包括核心柜面、存款产品工厂和存款业务专题。
cn/02-贷款核心/贷款核心知识,包括贷款业务专题;贷款柜面和贷款产品工厂页面解读后续补充。
cn/03-通用核心能力/跨存款和贷款复用的核心能力,如客户账户、授权、账务、内部户、日终等。
cn/assets/截图、图表和其他知识库资产。
en/英文学习版,使用 en-US 和美式银行/金融科技表达。

4、截图目录

截图统一放在:

text
wiki/cn/assets/screenshots/

按系统域继续拆分:

text
wiki/cn/assets/screenshots/01-存款核心柜面/
wiki/cn/assets/screenshots/02-存款产品工厂/
wiki/cn/assets/screenshots/03-贷款核心/

命名规则:

  • 有交易码时优先使用交易码,例如 3001.png
  • 同一交易多张图使用 3001-01.png3001-02.png
  • 没有交易码时使用稳定英文或拼音业务名。
  • 不使用空格。
  • 不随意覆盖旧图,除非确认是同一页面的清晰替换版。

5、核心柜面文档结构

核心柜面当前采用:

text
wiki/cn/01-存款核心/01-核心柜面/
├── README.md
├── docs/
└── topics/

docs/ 按系统菜单组织页面解读。

topics/ 保存银行术语和跨页面复用概念。

6、更新要求

每次新增资料时:

  1. 判断资料属于哪个系统域。
  2. 图片放入 wiki/cn/assets/ 对应目录。
  3. 页面级内容更新到对应 docs/
  4. 通用概念更新到对应 topics/wiki/cn/03-通用核心能力/
  5. 必要时更新 wiki/cn/README.mdwiki/cn/00-总览/学习路线.mdwiki/cn/00-总览/术语表.md
  6. 同步更新 wiki/en/ 下同路径英文页,新增术语先更新术语表。
  7. 更新后检查本地 Markdown 链接、图片引用和英文覆盖率。