# knowledge-base-cn

## **读流程**

### **Self-serving**

[**中文 KB 客户入口**](https://support.pingcap.cn/plugins/servlet/desk/portal/2)，不创建工单，KB 解决问题所占比率【待完善】

- 客户在 Support Portal 前端的行为埋点：搜索关键字、KB 页面停留时间、是否建单
- 搜索关键字次数统计：了解客户、产品、使用阶段，提供 KB 书写素材源；
- 页面标记 “对我有帮助”：视为客户主动反馈解决遇到的问题，否则走到下一个判断流程： KB 页面停留时间（默认 N min) + 是否建单子
- KB 页面停留时间： 关注超过 N 分钟左右的记录以及后续是否创建工单请求；
- 是否创建工单：
    - 如果搜索页面未建单，视为 KB 解决问题；
    - 如果搜索页面后建单，视为 KB 穿透到支持；

### **技术服务**

[**中文 KB 内部入口**](https://github.com/pingcap-inc/knowledge-base-cn)，创建工单，引用 KB 解决问题比率。

- **Tips**: 需要通过飞书工作流 `Github aalies to join PingCAP organization` 申请加入 `PingCAP-inc` 组织。

- 关单时，通过字段标记统计 KB 被引用解决问题，是否需要新增 KB 反馈。

![Read-workflow](/images/Read-workflow.png)

## **写流程**

调整到 GitHub 的私有 Repo，PingCAP 成员可见的 Private Repo。最终 Merge 到 Public 分支后，通过 Confluence 的 Marco 付费插件映射内容到 Confluence 并且 JSM 是 Public 可读状态。

- **作者**：以 GS L1 为主，邀请 PingCAP 任何一位对技术协作喜欢的伙伴加入，依旧参考之前的书写规范KB 书写规范指南 v0.1 - Confluence ，完成所负责的 Ticket 在 Close 时的 “现象明确，需要 KB” 素材的转化。

- **Reviwer**：以 GS L2 为主，依旧参考之前的书写规范KB 书写规范指南 v0.1 - Confluence ，确定内容满足标准后，就可以 Merge 到主分支，有 L2 或者系统管理员将内容创建到 Confluence 的 Public 空间中，确保是默认可见。
  
    - **Tips**: 可以参考 docs 的 CI 模块实现部分 Markdown 语法内容检查自动化；

- 原 Confluence 会做一次全量导入到 Github 的 Public 分支，后面逐步进行内容改变为映射内容的调整。

![Write-workflow](/images/write-workflow.png)

### [**KB 书写规范 v2.0 - Github 版本**](https://pingcap.feishu.cn/wiki/wikcnLYaGBcxjdJYAyVozTBdkea)

## **参考文档**

[Pingcap/Docs-cn 的 markdown 书写规范](https://github.com/pingcap/docs-cn/blob/master/resources/markdownlint-rules.md)

[KB 书写规范 v1.0](https://pingcap.feishu.cn/wiki/wikcnqjeoLNStY3pD6OUm9RxGLE)

[KB 书写规范培训视频](https://learning.pingcap.com/kng/view/package/52429869ba3b46e29134a073f1dd495b.html)