乐于分享
好东西不私藏

技术文档写作坑点-文档拆分

技术文档写作坑点-文档拆分

文档写作的坑 · 第4篇

一篇文档塞三个任务,谁都找不到自己要的

文档中的”和”字,往往是一个预警信号

一篇文档,两个人的困境

有一次我搜索”创建用户”,搜到一篇文档叫”创建和管理用户”。点进去一看,创建用户只占了1/3篇幅,剩下2/3都在讲怎么管理用户、分配角色、重置密码。

👤 我的搜索目标
搜”创建用户”
只想创建一个用户,但要在2/3无关内容里找到我要的
👤 同事的搜索目标
搜”管理用户”
只想管理用户,跳过创建部分,各自跳过大半内容
我们两个不同目标的人,被迫看同一篇文档,各自跳过大半内容。

三个判断标准:任一回答”否”就拆

文档里的任务可以独立完成吗?
创建用户和管理用户是两个独立任务,你不需要管理用户才能创建用户。
否 → 拆
文档的目标读者完全一致吗?
创建用户可能是普通管理员的事,管理用户可能是超级管理员的事。
否 → 拆
标题可以用一个动宾短语概括吗?
“创建管理用户”——”和”字是信号,说明你在用一篇文档覆盖两个任务。
否 → 拆

拆分前后:2800字 → 2×1000字

五个维度对比
维度多任务一篇单任务各一篇
读者定位混杂精准
搜索命中率
前提条件混乱清晰
文档长度长,需跳读短,全相关
维护成本

一个常见的反对意见

“拆分后文档变多了,不好管理。”

文档多不是问题,找不到才是问题。

拆分后用”相关文档”链接把同一主题的文档串起来,读者从”创建用户”的结尾能看到”下一步:管理用户角色”的链接,体验比在一篇长文档里翻找好得多。

另外,拆分后两篇文档的总字数比原来少了800字——因为删掉了原来为了把两个任务串起来而加的过渡段和重复说明。

一句话记住这篇
标题里的”和”字是文档该拆分的信号
📖 下一篇预告
截图:维护的噩梦,还是沟通的利器
本文由 AI 协助整理润色
更多技术文档写作干货
文档不头疼
👆 欢迎关注公众号
#文档不头疼#Carly聊技术写作#技术传播#文档拆分#信息架构#技术文档#单一职责