1. 金句:文档 = 契约
有一种定义很干净:文档是在与用户订立一份契约,告诉他们正在使用的东西应当如何工作。
合同纸上的字,法务会盯;帮助中心里的步骤,用户会按。按完失败,他们体验到的不是「文档团队忙不过来」,而是产品违约——功能说好能这样,现场却不能。售前演示按文档走通一遍,上线后按钮改名、权限模型换了,旧契约还挂在公网,违约就变成可转发的截图,再进客户群、再进复盘会,很少有人回头查「原文到底写在哪一版」。
把文档当说明书附件,履约是售后的事:产品先上线,说明以后补。把文档当契约,履约是发布的一部分:产品改了行为,对外承诺必须同天或同窗口可核。页数多少是印刷问题;契约有效无效,是信任问题。信任一旦按「以现网为准」口头抵挡,而现网又没有可分享的新约,这句话就是空头支票。
这里说的「契约」,不是法务意义上的盖章合同,而是用户按你写的做时,产品应当兑现的那份预期。预期对不上,锅很少记在「文档过期」四个字上,更多记在产品不稳定、实施不专业上。所以履约这件事,工程师也会痛——现网已变,对外说明未变,联调现场先炸。伙伴开发者按错误码表对接,表停在上一大版本,多耗的两周支持成本,最后常被写成「文档要重视」——然后文档仍然没有固定主人。
换尺子之后,问法也变了:从「这页写完了吗」,问到「用户按这页做,产品会不会这样工作」。写完只是印刷完成;履约才是契约生效。
2. 同步是第一痛,而且很多人没流程
行业公开调研里,文档与产品不同步常被列为最大工作流挑战;大约三成把它排第一,几乎是第二名的两倍。仍有约两成团队没有任何正式同步流程;工程师往往感觉最痛。也有团队说会按产品变更更新,比例不低——可「会更新」和「有流程、有主人、有完成定义」不是一回事。前者是意愿,后者是可验收的闭环。
国内现场更常见的是:发版在企微群里刷一屏;帮助中心靠有心人想起改;飞书里另有一份「给实施看的」;投标 PDF 还在网盘,文件名写着「最终版」。每个人都觉得自己同步过,用户面对的仍是多份契约并行。上午销售把能力边界写进方案书,下午客户自己点开帮助中心,步骤对不上——信任不是在谈判桌上丢的,是在浏览器地址栏里丢的。
没有流程的同步,本质是碰运气。运气好,改到了;运气不好,客户按旧约操作,你们用「以现网为准」抵挡。现若没有稳定、可回看的现行页,用户只能继续在群文件和收藏夹里找「比较新」的那份。新人入职第一周不是学产品,是学「这份东西到底以哪份为准」。
同步痛,表面上是「谁忘了改文档」,底下是可追溯性缺失:改动发生了,但对外承诺没有留下「改了什么、何时生效、旧步骤是否作废」的轨迹。群消息会沉底;可分享的地址与版本,才扛得住下周复盘。不确定答案对不对、版本新不新——这才是真实痛点,不是「页面不够多」。
再看客服排班现场:同一个「如何导出报表」反复进线。帮助中心里其实有这篇,可惜挂在冷门目录;站内搜索先冒出旧活动说明。于是客服打开收藏夹里的飞书,或翻企微「导出-新」聊天记录,把正确步骤再打一遍。人累,口径还在继续分叉。契约若只活在聊天记录里,履约就变成口耳相传——传着传着,就传丢了版本号。
3. 契约怎么履约:发版当天能对上那一版
履约不必神话成「代码一合并,文档自动完美」。先问一个能验收的问题:
发版当天,用户能不能选到、打开、按现行版说明做完关键路径?
多产品、多版本时,契约要带版本号。标准版与私有化、2025.3 与 2025.6,限制不同就应分开或明确标注;糊成一篇「活文档」,等于同时签了多份互相冲突的合同。废弃步骤要下场或标废弃,别让旧约继续可检索、可被助手引用——助手两边都采,总结会给你一个听起来很圆、实际上违约的答案。你以为上了 AI,其实只是把版本冲突自动化了。
完成定义里写下文档。功能「开发完成」若不含对外说明与日志,出的就是半发布:代码在,契约不在,或契约是旧的。销售方案可以提前透风,正式帮助与手册应对齐已发布行为——意向功能写进契约,是另一种违约。下一篇会专讲「没写出来就不算存在」;本篇只钉住履约窗口:同天、同版本、可核。
国内可执行的最小闭环往往是:发版说明有固定入口;手册/帮助有人认领改步骤;改完点发布;群通知里带现行页链接,而不是只丢一句「注意变更」。群可以快,契约必须落在可回看的地址上。能内容复用时,同一事实一处改、多门口到达,比三个人各改各的站点便宜;操作日志一类对外时间轴,则把「现在有了什么」说清楚,少靠记忆。过期入口比没有入口更伤——用户以为走进了正式通道,读到的却是过期事实。空着的叶子,有时候不如暂时不开。
4. Baklib:版本选择 + 日志,而不是群里再刷一屏
Baklib 侧,履约靠的是版本与发布面,不是再鼓励大家在群里刷一屏「重要通知」。
产品操作手册 支持多产品、多版本维护;产品日志 接住「现在有了什么」。帮助中心 与手册可同源发布到不同叶子;建设侧模板可点亮文档、反馈/日志、法务等触点。不吹「扫代码仓库自动开文档单」——那是别人案例里的做法,不是把未交付自动化写成你们的默认能力。能交付的是:真源可协作、版本可选择、发布可撤回回溯,发版时少靠记忆。
落地顺序通常经得起验证:先让现行版有门、找得到;再让日志与手册对得上;最后才加更多运营叶子。先证明「有门、找得到、对得上」,再谈更漂亮的活动页。门牌不妨多,事实源应一——改产品默认值,应能回到同一处真源,再发到该亮的门口,而不是拜托三个同事各改各的站点。
若你在软件或信息技术团队,角色落在产品、研发或知识管理,最小验收可以写成三句话:发版当天关键路径有现行页;日志说清「现在有了什么」;群通知带可回看链接而不是只刷口号。过得了这三句,契约才开始像契约;过不了,再多的「文档很重要」都是空话。空话不能履约,履约也不能靠空话——先把现行页立住。
契约的意义很土——用户按你写的做,产品就该那样工作。做不到,就更新契约或收回入口;空着有时比挂着旧约更诚实。文档是在与用户订立一份契约。签了,就要能履约;履约,就要发版当天还对得上那一版。对不上的字,留在公网上,不是资产,是未平仓的违约。