运维文档网站的真实成本
浏览:1
巴克励步
我在和不少做客户支持的朋友聊天时发现,大家最容易踩的坑就是低估了文档网站的成本——尤其是那种“自己搭一套”的方案。表面上看,静态站点生成器、Git仓库、免费托管都是免费的,但等真把编辑、协作、发布、搜索、安全这些都串起来,人力投入和隐性维护费用很快就超出了预算。更麻烦的是,如果团队里没人熟悉这套工具链,光是把基础流程跑通可能就要大半年。这让我想到,其实大部分公司需要的不是自己造轮子,而是一个开箱即用
我在和不少做客户支持的朋友聊天时发现,大家最容易踩的坑就是低估了文档网站的成本——尤其是那种“自己搭一套”的方案。表面上看,静态站点生成器、Git仓库、免费托管都是免费的,但等真把编辑、协作、发布、搜索、安全这些都串起来,人力投入和隐性维护费用很快就超出了预算。更麻烦的是,如果团队里没人熟悉这套工具链,光是把基础流程跑通可能就要大半年。这让我想到,其实大部分公司需要的不是自己造轮子,而是一个开箱即用的在线帮助中心建设方案,把精力省下来放在内容本身和客户体验上。
创建文档网站主要有两种方式:使用文档平台或自行搭建(比如采用 docs-as-code)。你选择如何创建文档网站,将显著影响其成本。
例如,我们曾在 LinkedIn 的 Documentation and Technical Writing Management 群组中发起了一项调查,询问运行 docs-as-code 设置的成本。约 47% 的受访者表示成本超过 5000 美元/年。
第一轮调查假定 DIY 成本很低,有些人甚至说它是免费的。根据评论区的建议,我们又在 /technicalwriting subreddit 上进行了第二轮调查,提高了金额选项。超过 68% 的受访者表示,构建和维护内部文档系统的成本超过 10000 美元。
💛🧡🧡客户评价:Baklib易于搜索,支持响应速度快,实施速度快。对内部和外部都有帮助使用。总体上对这个平台非常满意。 我们有很多流程文档,但Baklib使搜索和链接客户变得如此容易。客户自己可以找到任何东西,这很有帮助,无论是内部还是外部。
由于范围很广,我们询问了几位使用这些系统的专家。来自英国的 Technical Author Deborah Barnard 表示:“成本的简短答案是‘视情况而定’。你可以完全免费搭起来(例如静态站点生成器加主题,再加上免费的 Cloudflare Pages)。不过要记住时间成本。但基本的设置并不花时间,尤其是你已经熟悉静态站点技术并选好主题的话。另一端,如果你做重度定制(比如 Stripe 的做法——自定义 Markdown 解析器、自定义主题等),那你其实是在构建一个完整的产品,随之而来的是开发、设计和项目管理成本。”
免费的“开源平台”可能很有吸引力,但你需要为托管和开发人员时间买单,因此总成本可能难以控制。相比之下,文档平台每月可能只需 30 美元,也可能高达数千美元,视需求而定。平均而言,软件和产品文档门户的费用大约在每月 100 美元。
创建文档的基本要素
如果拆解到核心组件,构建文档需要三个要素:
- 用于编写内容的编辑器
- 用于分享和托管内容的方式
- 用于审阅和与领域专家协作的工作流
Docs as code 是对“如果我们从软件开发的角度来处理产品文档会怎样”这个问题的一种回答。Tom Johnson 将 docs as code 流程定义为具有以下特征:使用纯文本文件(通常为 .md 格式)、Git 进行文件管理或协作、文本编辑器编写内容、持续发布(CI/CD)和验证脚本、使用静态站点生成器来搭建网站。
有些人认为这更像是一种与开发者协作的方式,并非以技术写作为中心——它缺乏内容复用,结构僵硬(例如本地化)。DIY 的短板确实有解决方案,但用自己的时间搭建工具通常不是好主意。最终你可能会需要集成搜索解决方案、搭建验证管道、设置链接检查、选择静态站点生成器、建立发布网站,并将以上所有整合在一起——这最好由一个团队来完成,因为有时让一个单独的写作者来做太多了。
与内部系统相比,文档平台考虑了这些方面,从而提供易于设置和使用的工具来编写、协作和发布产品文档。像任何其他专有软件一样,这意味着你交出了一些原本可以控制的部分,作为交换,你获得了一个功能丰富的工具。更重要的是,任何文档系统的重点都应该是支持与技术和非技术队友的协作和审阅,因为这才是真正的工作发生的地方。
影响文档网站成本的因素
构建任何东西都没有“零成本”这回事。你可能使用免费的开源软件,但一个懂得如何设置它的人的年薪可能在 10 万到 20 万美元之间。有些技术作家知道如何设置,但他们通常是前开发人员,走这条路线的公司可能需要长达一年才能 100% 实现。
根据 WebFX 的数据,构建网站的平均成本在 1.2 万到 15 万美元之间,维护成本在每年 400 到 6 万美元之间——这还只是对普通网站而言。为什么范围这么大?因为多种因素影响网站成本。
软件
你首先要做出的最重要选择是使用开源软件还是像 Baklib 这样的商业软件。开源软件可以免费下载,但你需要考虑托管、SSL 证书、CDN、图片优化等其他成本,更不用说设置所花的时间。额外工具还能帮助你保护、更新和维护网站。搜索是面向客户的文档的关键要素之一,如果需要实现一个强大的搜索引擎,可能会增加成本。使用 SaaS,你无需担心托管、安全、性能、搜索和可用性——这就是你支付月费的原因。通用 CMS 的定价差异很大,例如 Contently 的价格范围为每月 3000 到 25000 美元。
托管成本
由于 SaaS 产品包含 Web 托管,因此你只需考虑开源解决方案的托管成本。大多数提供商提供不同的托管服务,包括共享、管理、VPS 和专用托管,价格范围约为每月 3 到 400 美元。
SSL 证书成本
SSL 证书是一种标准安全技术,用于保护访问者浏览器和你的网站之间的信息安全。因为它确保敏感密码和支付信息保持私密,访问者期望你的网站使用 SSL 进行加密。如果托管提供商不提供 SSL,你需要从 SSL 证书提供商处购买。少数提供商提供免费 SSL 证书,但大多数提供商的费用为每年 7 到 250 美元,具体取决于提供商。幸运的是,像 Baklib 这样的托管文档平台已包含 SSL 证书。
扩展成本
不同平台扩展的选择差异很大。对于大多数开源平台,你不局限于开箱即用的功能。你可以下载或购买扩展程序来为网站添加功能。例如,如果你需要对内容进行门控并控制谁有权访问门户,有第三方解决方案可以实现。其他支持应用市场的平台可能有生成门户的扩展程序,例如 Scroll View for Confluence。但这并不是为了增强用户体验,而是为现有工具寻找变通办法。
维护
维护网站的平均成本为每年 400 到 60,000 美元。最常见的维护成本是域名、SSL 证书和软件或托管续费,其他费用可能包括购买额外扩展程序或进行重大网站重新设计。
内容(每小时 35 美元以上)
就运行文档网站的成本而言,内容可能是最昂贵的元素。内容创作涉及大量协作和创造力,通常需要研究和技术能力,尤其是软件文档。想想你花了多少时间才建立起你所在领域的专业知识。技术作家不会一夜之间成为领域专家。为了避免这种学习曲线的成本,作家可能会在内容开发过程中与 SME 合作。而且大多数时候,作家会花 80% 的时间获取撰写所需的资源,只有 20% 的时间是在实际写作。将概念性想法从领域专家的大脑转化为非专业人士能够消化和理解的内容,其典型流程如下所示。即便如此,内容是你将在文档网站上做的最重要的投资之一,并且需要定期更新。
要素成本软件每月 0 至 25,000 美元托管每月 3 至 400 美元SSL 证书每年 0 至 250 美元扩展每个扩展 0 至 200 美元维护每年 400 至 60,000 美元总计每年 403 至 85,850 美元你应该选择什么?
预算始终是一个考虑因素。你可以以低至 100 美元的价格推出文档门户,但很可能需要花费更多才能让它运转起来。举个具体例子:ClickHouse 最近推出了重建的文档网站。他们选择了 Docusaurus,实施用了两周。很多软件公司都是这样起步的——基于 Markdown,他们拥有很多控制权,但有一个“但是”。devdocs.work 的联合创始人 Travis Long 说:“没有一个一刀切甚至相对粗略的估算我能给出所有 docs as code 的建造成本。每个团队有不同的需求和目标,因此需要不同程度的可定制性。比如,文档团队是否希望在其帮助中心页面上提供客户反馈功能,如评论区或赞/踩?团队是否从旧的、不直观的遗留系统迁移,在这些系统中你必须手动调整每个页面的样式/反向链接和资源?这些事情会极大地改变项目的规模和预算。”
Docs-as-code 与文档平台
这里没有对错之分,只是“视情况而定”。但有几件事需要考虑。维护工具有大量隐藏成本,并且关于需要使用这种系统有很多错误假设,尤其是如果需要文档的公司不确定未来 1-3 年需要什么功能。如果我们谈论的是 Stripe 质量的文档,那么每年仅仅维护文档基础设施和工具就超过 150 万美元的人力成本(仅针对专职文档人员),更不用说实际维护内容本身了。Stripe 文档产品团队的 Technical Writer Ryan Paul 讨论了为其下一代文档平台开发新创作系统的情况。有时,即使是中型公司也会在 docs-as-code 工具上投入数年时间进行构建。最终,他们发现自己大部分时间花在维护工具、修复错误和添加功能上,而不是编写内容。如果你正在招聘技术作家,内部系统可能会缩小候选人池。并非所有技术作家都愿意学习新设置——他们是否熟悉 push/pull/merge/PR 的工作方式?此外,还有其他内部因素需要考虑——审阅流程是什么?利益相关者是否期望以发布时的格式进行审阅?有多个因素需要权衡,选择合适的软件更多取决于你拥有的资源,而不是成本,因为两者最终都可能既便宜又昂贵。
如你所见,文档网站的成本并不会高得离谱。但如果你想添加自定义功能或有特定要求,可能会增加总成本。Baklib 是灵活的,让你可以预先选择花费多少,从而无需头疼的工程难题即可构建文档网站。