「B端」用户使用文档网站的几种实现方案

最近产品给我提了一个需求，内容是要做一个B端的用户使用文档手册站点。

实现过程中发现有多种实现方案，但是不同的方案耗费的人力成本也不同。

于是总结了这篇文章来讲讲不同方案的优缺点和注意点。

一、完全手写代码方式

这是最原始的实现方式。当产品给到类似word的使用文档时，开发就按照文档的样式，

一行行复制文档内容，粘贴到代码里面，然后再给文档写上各种样式。

这是效率比较低的实现方式。

这种方式的话，比较适用于文档很少，变动也很少，并且文档是非独立网站的场景。

二、内容下发方式

内容下发方式指的是，文档的全部内容保存在服务器，通过后端下发文档内容，前端拿到文档内容后动态渲染出来。

这种方式一般都会有一个文档编辑管理后台，产品和运营在管理后台的富文本编辑框编辑好文档的目录和文档内容后，

点击发布文档，然后文档会被下发到文档网站前端，最后前端拿到内容后渲染出来。

这种实现方式比较复杂，并且人力成本很高。

这种方式的话，比较适用于大型的文档网站，并且文档内容经常变更，文档实时性也比较强的场景。

像腾讯云的各种使用文档，就是采用的这种方式。

也有看到过一些to B的服务提供商把它当作文档服务来对外售卖，通过使用它的服务，来快速搭建出一个文档网站。

三、自动转化成代码方式

指的是产品提供markdown文档，然后开发把markdown文档保存在前端代码里面，经过构建后，把markdown文档转换成html网页的方式。

后续产品要更新文档时，只需要把最新的markdown文档给到开发，开发做下替换，然后再发布下代码就ok啦。

这是成本比较低的一种实现方式。目前市面已经有很多成熟的文档框架可一键生成，只要替换下主题、文档内容就可以了。

需要注意的是它的文档内容都是保存在前端代码项目里面的。

这种方式比较适用于，文档内容偶尔变更，实时性不是很强的场景。

小结：一个B端产品，一般都会有用户使用操作文档，一个独立的文档网站该如何设计，

需要考虑文档内容是否经常变更、实时性要求高不高、是否需要登录态才能查看等等。

--- end ----