鲸先知识库内容贡献指南

感谢您为鲸先知识库贡献内容！本指南帮助您快速上手并确保内容质量。

目录

• 快速开始
• 目录结构
• 文档规范
• 内容分级
• 品牌规范
• 提交检查清单
• 常见问题

快速开始

1. 使用模板创建文档

所有产品文档应从模板开始：

# 模板位置
docs/templates/
├── product-overview-template.md    # 产品概述
├── product-features-template.md    # 功能清单
├── product-tech-template.md        # 技术架构
├── case-study-template.md          # 客户案例
└── competitive-analysis-template.md # 竞品分析

2. 复制模板

# 示例：创建新产品概述文档
cp docs/templates/product-overview-template.md docs/products/{layer}/{product-id}/index.md

3. 填充内容

按模板中的 {占位符} 填写内容，删除不需要的部分。

目录结构

lwkb/
├── docs/
│   ├── .vitepress/          # VitePress 配置
│   ├── company/             # 公司信息
│   │   ├── index.md          # 公司概述
│   │   ├── brand.md          # 品牌规范
│   │   ├── about.md          # 关于我们
│   │   └── contact.md        # 联系方式
│   ├── products/            # 产品体系
│   │   ├── index.md          # 产品总览
│   │   ├── architecture.md   # 架构规范
│   │   ├── baas/             # 核心能力层
│   │   │   ├── index.md
│   │   │   ├── {product}/
│   │   │   │   ├── index.md      # 产品概述（必填）
│   │   │   │   ├── features.md   # 功能清单
│   │   │   │   ├── tech.md       # 技术架构
│   │   │   │   ├── pricing.md    # 定价方案
│   │   │   │   └── faq.md        # 常见问题
│   │   ├── saas/             # 场景应用层
│   │   └── solutions/        # 行业解决方案
│   ├── industries/          # 行业方案
│   ├── technology/          # 技术方案
│   ├── cases/               # 客户案例
│   ├── insights/            # 洞察文章
│   ├── resources/           # 原始资料
│   ├── templates/           # 文档模板（参考用）
│   └── CONTRIBUTING.md      # 本文档

文档规范

文件命名

产品文档：

docs/products/{layer}/{product-id}/
├── index.md          # 产品概述（必填）
├── features.md       # 功能清单（推荐）
├── tech.md           # 技术架构（推荐）
├── pricing.md        # 定价方案
├── roadmap.md        # 产品路线图
└── faq.md            # 常见问题

原始资料：

docs/resources/{product-id}/
├── index.md                              # 资料索引
└── {YYYY-MM-DD}-{source}-raw.md         # 原始资料

命名规范：

• 文件名使用小写字母、数字、连字符 -
• 不使用中文文件名
• 不使用空格

❌ 错误：产品介绍.md、New Document.md、doc_v1.md ✅ 正确：product-overview.md、new-document.md、doc-v1.md

Frontmatter 格式

每个 Markdown 文件必须包含 frontmatter：

---
title: {文档标题}
description: {文档描述}
product: {product-id}        # 产品标识
layer: {baas|saas|solutions} # 产品层级
industry: {industry-id}      # 行业（可选）
status: {draft|published}    # 状态
created: {YYYY-MM-DD}        # 创建日期
updated: {YYYY-MM-DD}        # 更新日期
---

内容格式

标题层级：

# 页面标题（H1）
## 大节标题（H2）
### 小节标题（H3）
#### 详细标题（H4，尽量避免）

表格格式：

• 表格必须有表头
• 表格内容左对齐
• 数字右对齐

图片格式：

![图片描述](/images/{path}/{filename}.png)

链接格式：

[链接文字]({path})

内容分级

内容按严谨度分为三个等级，详见 content-levels.md：

等级	说明	应用场景
L1	必读层：精华概览	销售概述、首次会议
L2	详解层：完整信息	招标、方案设计
L3	深度层：专业细节	技术对接、白皮书

新产品上线节奏

1. Week 1：填充 L1 内容（商业可用）
2. Week 2：补充 L2 内容
3. Month 1：完善 L3 内容

品牌规范

公司名称

类型	正确	说明
全称	深圳市普尔瀚达科技有限公司	官方名称
简称	普尔瀚达	日常使用
英文	pooul	官方英文名

品牌名称

类型	正确	说明
中文	鲸先	品牌名
英文	Leader Whale	英文品牌名
缩写	LW	英文缩写

产品命名

必须使用：鲸先 + 产品名

产品	正确命名	英文名	英文缩写
企业支付	鲸先企付	Leader Whale Enterprise Payment	LWEP
医药流通	鲸先微药通	Weiyaotong	-
品牌分销	鲸先分销易	Fenxiao Yi	-

❌ 错误：企付、微药逐、分销易 ✅ 正确：鲸先企付、鲸先微药通、鲸先分销易

文档命名示例

❌ 错误：

• 企付产品介绍.pdf
• 微药通解决方案.pptx

✅ 正确：

• 鲸先企付产品介绍.pdf
• 鲸先微药通解决方案.pptx

提交检查清单

基础检查

• [ ] 使用了正确的模板
• [ ] Frontmatter 完整且格式正确
• [ ] 品牌名称符合规范（鲸先 + 产品名）
• [ ] 文件名命名规范
• [ ] 无拼写和语法错误

内容检查

• [ ] 包含一句话产品介绍
• [ ] 包含目标客户描述
• [ ] 图片有 alt 文本
• [ ] 链接可正常跳转
• [ ] 表格有表头

技术检查（如适用）

• [ ] Mermaid 图表语法正确
• [ ] 代码块有语言标记
• [ ] API 文档参数完整

常见问题

Q: 如何确定产品属于哪个层级？

参考三层架构：

• BaaS（核心能力层）：技术底座，API能力输出
• SaaS（场景应用层）：通用场景，标准化应用
• Solutions（行业解决方案）：垂直行业，深度定制

Q: 原始资料如何整理？

1. 将原始文档（PPT/Word/PDF）转换为 Markdown
2. 保存到 docs/resources/{product-id}/
3. 文件名格式：{date}-{source}-raw.md
4. 在索引文件中添加条目
5. 提取关键信息到产品文档

Q: 如何更新已发布文档？

1. 修改内容
2. 更新 frontmatter 中的 updated 字段
3. 在文档末尾添加更新日志
4. 提交时注明更新内容

Q: 图片存放在哪里：

• 公共图片：docs/public/images/
• 产品图片：docs/public/images/products/{product-id}/
• 引用方式：/images/{path}/{filename}.png

Q: 如何部署？

# 本地预览
npm run dev

# 构建
npm run build

# 部署
make deploy

联系我们

如有问题或建议，请联系：

• 知识库管理员：[email]
• 技术支持：[email]

---

本指南最后更新于：2026-04-18