知识库文档命名规范

本标准规定鲸先知识库中所有文档、目录、路径的命名规范。

---

核心原则

1. 国际化优先

• 必须使用英文命名，禁止使用中文拼音
• 目标是让非中文用户也能理解 URL 和文件结构

2. 纯 ASCII 字符

• 只使用小写英文字母 a-z
• 数字 0-9
• 连字符 - (hyphen)
• 禁止使用：中文、空格、下划线 _、特殊字符

3. kebab-case 格式

• 所有文件名和目录名使用短横线连接
• 例：product-overview.md 而非 product_overview.md 或 productOverview.md

4. 简洁可裁剪

• 文件名应简洁明了
• 可根据实际情况裁剪，但要保持唯一性

---

路径命名规范

目录结构示例

lwkb/docs/
├── company/                      # 公司信息
├── products/                     # 产品体系
│   ├── baas/                      # 核心能力层
│   ├── saas/                      # 场景应用层
│   └── solutions/                 # 行业解决方案
├── industries/                   # 行业方案
├── technology/                   # 技术方案
├── cases/                        # 客户案例
├── insights/                     # 洞察文章
├── templates/                    # 文档模板
└── standards/                    # 标准规范

目录命名规则

目录	命名	说明
公司信息	company/	通用命名
产品体系	products/	包含 BaaS/SaaS/Solutions 三层
核心能力层	products/baas/	BaaS = Banking as a Service
场景应用层	products/saas/	SaaS = Software as a Service
行业解决方案	products/solutions/	垂直行业方案
行业方案	industries/	行业解决方案概述
技术方案	technology/	技术架构和方案
客户案例	cases/	案例分析
洞察文章	insights/	行业洞察
文档模板	templates/	标准模板
标准规范	standards/	规范文档

---

文件命名规范

产品文档命名

产品文档使用英文缩写作为文件名：

产品名称	缩写	概述文档	功能清单	技术架构
鲸先BaaS平台	LWBaaS	baas-platform.md	baas-platform-features.md	baas-platform-tech.md
鲸先企付	LWEP	lwep.md	-	lwep-tech.md
银企财资	LWCT	lwct.md	lwct-features.md	lwct-tech.md
鲸先云账	LWCL	lwcl.md	lwcl-features.md	lwcl-tech.md
鲸先收款	LWAR	lwar.md	lwar-features.md	lwar-tech.md
鲸先付款	LWAP	lwap.md	-	lwap-tech.md
鲸先财资	LWT	lwt.md	-	lwt-tech.md
鲸先预付	LWPG	lwpg.md	lwpg-features.md	lwpg-tech.md
鲸先微药通	LWPF	lwpf.md	lwpf-features.md	lwpf-tech.md
鲸先分销易	LWDP	lwdp.md	lwdp-features.md	lwdp-tech.md
鲸先租赁易	LWLE	lwle.md	lwle-features.md	lwle-tech.md

案例文档命名

案例文档使用 case-{product}-{industry} 格式：

产品	行业/场景	文件名	说明
鲸先微药通	医药流通	case-lwpf-pharma-a.md	pharma = pharmaceutical
鲸先微药通	医药流通(补充)	case-lwpf-pharma-b.md	多案例时加序号
鲸先收款	教育培训	case-lwar-education.md	education = 教育培训
鲸先企付	连锁餐饮	case-lwep-catering.md	catering = 餐饮连锁
鲸先企付	电商平台	case-lwep-ecommerce.md	ecommerce = B2B电商
鲸先分销易	品牌分销	case-lwdp-brand.md	brand = 品牌分销
鲸先租赁易	物业租赁	case-lwle-property.md	property = 物业租赁

通用文档命名

文档类型	命名示例	说明
概述页面	index.md	目录默认页面
品牌规范	brand.md	品牌相关
公司介绍	about.md	关于我们
联系方式	contact.md	联系信息
产品架构	architecture.md	架构规范
命名规范	naming-convention.md	命名标准
文件命名	file-naming.md	本文档

---

URL 生成规则

VitePress 根据文件路径自动生成 URL：

文件路径	生成的 URL
docs/products/saas/lwar.md	/products/saas/lwar
docs/marketing/cases/case-lwar-education.md	/marketing/cases/case-lwar-education
docs/company/brand.md	/company/brand
docs/products/index.md	/products/

注意：每个目录下的 index.md 会被映射为该目录的根路径。

---

禁用示例

❌ 不正确的命名

# 禁止使用中文拼音
❌ jing-xian-shou-kuan.md
❌ wei-yao-tong.md
❌ case-lwep-canyin.md      # canyin 是拼音
❌ case-lwpf-yiyao.md        # yiyao 是拼音

# 禁止使用下划线
❌ product_overview.md
❌ case_lwep_catering.md

# 禁止使用大写字母
❌ ProductOverview.md
❌ Case-LWEP-Catering.md

# 禁止使用空格
❌ product overview.md

# 禁止使用中文字符
❌ 产品概述.md

✅ 正确的命名

# 产品文档
✅ lwar.md
✅ lwep.md
✅ lwpf.md
✅ lwct-features.md
✅ lwcl-tech.md

# 案例文档
✅ case-lwep-catering.md
✅ case-lwep-ecommerce.md
✅ case-lwpf-pharma-a.md
✅ case-lwar-education.md
✅ case-lwdp-brand.md
✅ case-lwle-property.md

# 通用文档
✅ index.md
✅ brand.md
✅ about.md
✅ naming-convention.md

---

目录命名对照表

英文简写 vs 全称

简写	全称	中文
baas	Banking as a Service	银行即服务
saas	Software as a Service	软件即服务
saas	Software as a Service	软件即服务
lwep	Leader Whale Enterprise Payment	鲸先企付
lwar	Leader Whale Accounts Receivable	鲸先收款
lwap	Leader Whale Accounts Payable	鲸先付款
lwt	Leader Whale Treasury	鲸先财资
lwpg	Leader Whale Prepaid Guardian	鲸先预付
lwct	Leader Whale Connect Treasury	银企财资
lwcl	Leader Whale Cloud Ledger	鲸先云账
lwpf	Leader Whale PharmaFlow	鲸先微药通
lwdp	Leader Whale DistriPay	鲸先分销易
lwle	Leader Whale LeaseEase	鲸先租赁易

---

更新记录

日期	版本	变更说明
2025-04-19	1.0	初始版本，统一知识库文档命名规范

---

相关文档

• 产品命名规范
• 品牌规范