如何不依赖开发人员搭建产品文档网站
浏览：0
巴克励步
我经常听到产品经理抱怨，文档网站的搭建总是被排到开发任务的最低优先级。说实话，我理解——开发资源本就紧张，让他们花时间做前端页面、配置域名、写样式，不如专注核心功能。但产品文档又是客户自助服务的入口，直接影响留存和转化。所以，我一直在寻找一种让非技术人员也能独立完成文档网站建设的方法。Baklib 的产品手册建设能力正好解决了这个痛点：无需写一行代码，就能从内容创作、站点设计到发布上线全流程搞定，而
我经常听到产品经理抱怨，文档网站的搭建总是被排到开发任务的最低优先级。说实话，我理解——开发资源本就紧张，让他们花时间做前端页面、配置域名、写样式，不如专注核心功能。但产品文档又是客户自助服务的入口，直接影响留存和转化。所以，我一直在寻找一种让非技术人员也能独立完成文档网站建设的方法。Baklib 的产品手册建设能力正好解决了这个痛点：无需写一行代码，就能从内容创作、站点设计到发布上线全流程搞定，而且支持多站点、多语言和 AI 搜索，让产品手册真正成为可运营的业务资产。
如何不依赖开发人员搭建产品文档网站
对大多数软件公司来说，为产品搭建一个文档门户至关重要。
研究一致表明，开发文档或用户指南是客户在联系客服之前最先寻找答案的地方。
那么，如何开始呢？无论产品类型如何，你都可以在 1 小时内建立一个文档网站，且完全不需要任何开发支持。
💛🧡🧡客户评价：就上下文而言，我非常使用Baklib因为我是我组织的主要管理员。我不是目前实施，所以我不能就此发表意见。不过，我可以这么说Baklib拥有出色的客户服务，反应迅速。他们还有一个愿意帮助您定制几乎任何东西的定制团队。用户界面简单易用。总的来说，我还挺满意的与平台。
随着市场向自助服务产品发展（产品驱动增长主导），一个能够让非技术人员轻松发布新信息的文档门户已成为必备。
你将领先于竞争对手，因为你可以自己完成大部分构建，并定期更新文档以提高产品采用率和用户留存。
最后，这种方法成本低廉。启动任何类型网站的费用从每月 30 美元到数千美元不等，本指南将为你节省大量时间和金钱。
以下是完整的逐步流程：
- 注册文档平台
- 添加内容
- 添加自定义域名
- 品牌定制网站
- 预览文档门户
- 分享给用户
如何创建文档网站——鸟瞰图
你可以在不消耗开发工时等宝贵资源的情况下构建一个文档网站，这些资源最好用于持续改进产品，而不是处理旁支任务。
那么，当开发团队不在场，或者构建时间表还有几个月才能上线，而你急需时，你该怎么办？
无论你撰写和发布文档的水平如何，我们都为你准备了量身定制的方案。
- 为什么要选择 Baklib 作为你的网站平台？
- 熟悉 Baklib 用户界面
- 如何设置自定义域名和访问控制
- 开始构建页面
- 品牌定制你的文档网站
- 添加自定义代码
说实话，构建一个文档网站与制作其他任何网站并没有太大不同，但在深入细节之前，先假设一些条件：
- 你已经拥有一个域名（如果你想使用的话）；
- 快速上手比拥有完全控制更重要；
- 非技术人员将参与文档创作和贡献；
- 你不希望开发团队维护和构建网站。
第一步：选择 Baklib 作为你的文档平台
有很多选项可以创建面向客户的知识库。从开源到商业，从无代码到“我需要开发人员来修改这个字体”，应有尽有。
文档网站有很多不同类型——从开发文档和 API 参考到用户指南——但它们都有一些共同特点。以下是一个成功的文档网站的特征：
- 支持多产品和版本管理；
- 支持本地化；
- 对读者进行访问控制；
- 轻量级模板和定制选项；
- 预览和生产环境；
- 强大的搜索功能，快速定位信息；
- 快速加载和 SEO 选项；
- 捕捉读者反馈的选项。
认识一下 Baklib——专为产品、开发人员和 API 文档设计的文档平台，支持对读者进行私有或公开访问。
以下是为什么选择 Baklib 是正确的关键细节：
将静态文档转化为即时答案
构建易于导航、搜索和分享的精美知识门户。
- 使用 30+ 自定义块和 Markdown 支持，添加内容变得轻而易举；
- 易于导入和同步 OpenAPI/Swagger 文件；
- 支持导入 Postman 集合；
- 用途广泛——可运行多种类型的文档站点：私有、公开、开发文档、API 参考、用户指南或产品手册。
- 快速、优化且安全；
- SEO 友好。
在 Baklib 中，内容组织成“空间”。在每个空间下，你可以添加多个文档，并以嵌套结构排列。文档可以转换为分类以改善信息架构。你对文档所做的任何编辑都会自动保存，所以不用担心丢失工作。
空间默认是私有的，但当你将其设为公开时，可以在子域名上共享它，Baklib 会负责托管（包括 SSL 证书、CDN 和图片优化）。
第二步：熟悉 Baklib 用户界面
现在，你应该对几个 Baklib 的基础概念有所了解，这将增强你后续的体验，并且你可以开始添加内容。你可以点击这里注册 21 天免费试用（无需信用卡）。登录后，你会看到以下界面：
（图片已省略）
Baklib 用户界面
(1) 空间
(2) 文档
(3) 编辑器
(4) 发布选项
(5) 搜索
(6) 邀请成员
(7) 导入内容
(8) 知识图谱
(9) 可复用内容
(10) 模板
(11) 归档
(12) 文档选项
(13) 读写模式
(14) 面包屑导航
(15) 通知中心
(16) 设置
(17) 专注模式
第三步：开始添加内容
文档有多种形式和格式。你可能已经有了一些资源，或者需要从头开始。来看看如何在 Baklib 中添加内容。
a) 在 Baklib 内直接编写
创建新文档后，你可以使用 Markdown 快捷键或 30+ 自定义块来添加内容。
自定义块帮助你按需格式化内容。要打开它们，在编辑器中键入斜杠 / 并浏览选项。
这些块分为基础、媒体、开发、嵌入和内容复用。
例如，如果你想动态链接到其他文档，输入 @ 和文档标题。这将连接到文档 ID。即使你更改了标题或文档位置，链接始终指向它。
另一个例子是调用块名称。敲 / 并输入块名称，例如 /verticalsplit，会筛选出你要使用的块。
第三个选项是使用括号和块名称——例如 (api)——将添加 API 端点块。
b) 复制粘贴
老派的复制粘贴法。但为什么要提到这个？因为 Baklib 的编辑器支持 Markdown，如果你想以这种格式粘贴，可能会看到以下消息：
“我们检测到剪贴板中有一些 Markdown 内容。你想粘贴 Markdown 吗？”
如果你点击取消，内容将不会渲染；如果在对话框中点击确定，我们会将 Markdown 转换为 Baklib 的块。
因此，你可以将代码示例渲染为 Baklib 中的代码编辑器块。
c) 导入 Markdown 或 Word 文件
复制粘贴效果不错，但如果你有 Markdown 或 Word 文件，为什么不将它们导入到空间中呢？
在导入任何内容之前，请确保点击要导入文件的空间。然后选择文件类型，省去从其他来源复制粘贴的几分钟时间。
d) 导入 OpenAPI/Swagger 文件或 Postman 集合
在文档化 API 时，你有多重选择。
假设你使用 OpenAPI（原 Swagger）标准。这允许轻松导入和同步文件。
导入到 Baklib 后，内容将以三栏布局渲染，便于管理文档。
e) 同步 GitHub 仓库
有时文档写在 GitHub 仓库中，你可以继续在 GitHub 中编写，并将仓库与 Baklib 空间同步。好处是你可以将该空间发布到自定义域名，并添加其他包含额外信息（如 API 参考）的空间。
第四步：设置自定义域名和访问控制
在你开始处理内容之前，先走一小步，这将产生很大的影响。设置你的子域名以访问预览和生产环境。前往文档页面，按照步骤添加自定义域名。
（图片已省略）
Baklib 自定义域名
在“常规”选项卡下有多个选项——你可以从同一个空间设置中关闭“可被搜索引擎索引”（如果是公开的）。通常你希望开启此功能，以便用户在搜索引擎结果页中找到你的站点。你可以进入“公开访问控制”选项，从五个选项中选择以获得更多控制。
- 无：保持对公开空间的设置。
- 密码：设置空间密码。拥有链接和密码的每个人都能读取内容。
- 访客账户：创建访客账户。拥有链接和访客账户的每个人都能读取内容。访客账户不计入 Baklib 的坐席数。
- 魔法链接：输入特定邮箱或添加整个域名白名单，用户将通过我们发送到邮箱的链接进行身份验证。
- JWT 认证：查看文档页面了解如何设置。如果你不希望用户每次都登录，这是一个完美的选择。
第五步：开始构建页面
在编写任何文档之前，先考虑你要涵盖的主要主题。这时笔和纸可能会帮你画出结构。
接下来，创建一个文档，将其转换为分类，并为其命名。
准备好后，就可以在每个分类下添加文档了。
从一个介绍用户在文档网站上会看到的主要内容的文档开始。不必复杂，以下是我们用户指南中的做法：
- 快速入门
- 编辑器
- 文档
- 空间
- 托管空间
- 组织
- 导入和导出
- 集成
- 指南
- 公开 API
- 其他
当你开始添加内容时，拥有一个工作流很重要。以下是一个可能的工作流，但你可以根据需要进行调整：
- 在“我的私有文档”中开始草稿。这有助于你编写任何还不想与团队分享的内容。
- 准备好后，将其移动到公开空间。
- 通知团队成员文档已准备好审阅。
- 如果需要，在需要其他用户输入的地方添加内联评论。
- 对变更满意后，发布到预览环境查看暂存站点。
- 如果一切正常，发布到生产环境，并宣布上线。
使用模板可以让贡献者更容易开始编写内容。你可以保存一套模板来帮助启动内容生产。如果需要灵感，在创建新文档时，你会看到页面底部有一个按钮：“从模板开始”。要构建自己的模板，请前往左侧导航栏中的“模板”，开始创建具有所需文档结构的文档。
你也可以引入作者将使用的自定义块，或添加来自其他来源的示例。
永久链接和 SEO 设置
这些选项位于文档级别。因此，你需要点击右上角的三点菜单，选择“SEO 元控制”。
添加相关标题、更改 URL、编写元描述或上传预览图片。
第六步：品牌定制你的文档网站
在“外观”选项卡中，你可以找到品牌选项，如强调色、Logo 和 Favicon，以及模板的其他选项。
（图片已省略）
Baklib 外观选项
根据产品或服务的类型，你可能希望有不同的空间 URL 路径。
你可以将一个空间作为主要文档，并针对其他产品或版本创建不同的空间。
有个快捷方式！如果只是增量更改，你可以克隆任何空间。这有助于保持结构，并为新版本进行编辑。
因此，如果你需要版本管理和多产品支持，请使用不同的空间，并附加相关路径或自定义域名。
前往空间链接，开始构建导航。
知识无处不在，一次创建，随处部署；您可以在一个位置创建可信知识，并将其部署在个性化门户、工作流程中的多种模式（例如网站和移动应用程序上的第三方桌面或小部件）、多种语言和交互渠道中。单一来源的内容和指导可确保一致性和合规性，并在知识库中建立信任，从而推动采用和价值创造。此外，Baklib支持30种开箱即用的语言，并且可以配置为能够以任何这些语言解释、分类和回复客户消息。
