技术文档写作坑点-文档拆分
一篇文档塞三个任务,谁都找不到自己要的
一篇文档,两个人的困境
有一次我搜索”创建用户”,搜到一篇文档叫”创建和管理用户”。点进去一看,创建用户只占了1/3篇幅,剩下2/3都在讲怎么管理用户、分配角色、重置密码。
三个判断标准:任一回答”否”就拆
拆分前后:2800字 → 2×1000字
一个常见的反对意见
文档多不是问题,找不到才是问题。
拆分后用”相关文档”链接把同一主题的文档串起来,读者从”创建用户”的结尾能看到”下一步:管理用户角色”的链接,体验比在一篇长文档里翻找好得多。
另外,拆分后两篇文档的总字数比原来少了800字——因为删掉了原来为了把两个任务串起来而加的过渡段和重复说明。

夜雨聆风