银行核心知识库

简体中文

English

简体中文

English

外观

项目运作规则 ​

本文档说明本项目日常如何维护、同步、检查和发布。它是团队协作时的统一操作口径。

1、项目定位 ​

本项目是团队内部银行核心知识库，用于沉淀核心银行业务、系统页面解读和英文学习材料。

英文版服务内部学习，不是客户文档，也不是面向非洲市场的本地化版本。英文表达统一使用 en-US，优先采用美国银行、核心银行系统和金融科技团队常用说法。

2、源头和生成目录 ​

所有正文都必须在源目录维护，不直接修改同步生成目录。

目录角色运作规则
wiki/cn/中文业务知识源头新增截图、页面解读、业务专题、术语时先更新这里。
wiki/en/英文学习版源头与 wiki/cn/ 保持同路径结构，使用美式英文重写同一业务内容。
wiki/cn/assets/知识库资产源头截图、图表和附件统一放这里，再用相对路径引用。
project-docs/项目规则和说明源头放目录说明、维护规范、翻译规范、部署说明和开发计划。
web/Web 展示系统只维护站点代码，不维护业务正文。
web/wiki/、web/project-docs/同步生成内容由 npm run sync 生成，不手工修改；中文生成到 web/wiki/cn/，英文生成到 web/wiki/en/。
scripts/自动化脚本放同步、侧边栏生成、链接检查和覆盖率检查脚本。

3、内容更新流程 ​

新增或修改业务知识时，按以下顺序执行：

  1. 判断内容属于总览、存款核心、贷款核心还是通用核心能力。
  2. 中文内容更新到 wiki/cn/ 对应目录。
  3. 截图保存到 wiki/cn/assets/ 下的对应子目录。
  4. 如果新增术语，先更新 wiki/cn/00-总览/术语表.md。
  5. 同步更新 wiki/en/ 下同路径英文页。
  6. 如果新增中文目录名，确认英文侧边栏是否需要在 scripts/build-sidebar.mjs 补充英文目录映射。
  7. 运行检查和构建。

如果只是修中文错别字、标点或格式，且不改变业务含义，可以不立即同步英文；如果修改了字段解释、流程、规则、风险点、术语或页面关系，必须同步英文。

4、中英版本规则 ​

wiki/cn/ 是业务事实源头，负责保留截图事实、专家解读、业务流程和风险控制点。

wiki/en/ 是英文学习版，负责用 en-US 和美式银行表达讲清楚同一业务内容。英文不是逐字翻译，但不能改变业务事实、页面关系和风险含义。

除英文站点首页 wiki/en/index.md 外，中文 Markdown 都应有同路径英文页：

text
wiki/cn/<relative-path>.md
wiki/en/<relative-path>.md

每个英文页必须保留：

md
> Chinese source: 中文标题，对应路径写成真实链接
> Locale: en-US
> Audience: Internal learning

5、Web 同步和发布流程 ​

Web 站点的展示路径和源码目录不是一回事：

内容源目录Web 路径
中文 Wikiwiki/cn//wiki/cn/
英文 Wikiwiki/en//wiki/en/
项目文档project-docs//project-docs/

每次准备预览或部署前，在 web/ 下执行：

bash
npm run check
npm run build

npm run check 会自动执行同步，并检查：

  • Markdown 本地链接和图片引用。
  • wiki/cn/ 与 wiki/en/ 的英文覆盖率。
  • 英文页是否保留 Chinese source:。
  • 英文侧边栏是否残留中文标签。

本地预览使用：

bash
npm run dev

当前部署方式是手动部署：本地构建后，将 web/.vitepress/dist/ 中的内容上传到宝塔网站根目录，并用宝塔访问控制保护整个站点。

6、提交前检查清单 ​

提交或部署前至少确认：

  • 业务正文没有手工写到 web/wiki/ 或 web/project-docs/。
  • 新增中文 Markdown 已有同路径英文页。
  • 英文页标题和侧边栏显示为自然英文。
  • 新术语已进入术语表，英文表达与术语表一致。
  • 截图不包含未打码的真实客户信息、账号、证件号、手机号、余额或流水号。
  • cd web && npm run check 通过。
  • cd web && npm run build 通过。

7、相关规范 ​