文档是支持内容的另一半
大多数帮助中心需要两种格式。有人观看,有人浏览——搜索引擎索引文字。分别制作意味着将同一 walkthrough 写两次——然后翻译两次。
一个脚本,两个输出
Capture 已必须充分理解您的录制以清理旁白。该清理脚本正是逐步指南所需的,因此书面版本是副产品而非第二个项目。
当您更愿意演示时如何撰写软件文档
询问维护帮助中心的人,撰写软件文档慢在哪里——从来不是打字。而是决定步骤顺序、记住自动跳过的前提条件,以及足够精确地描述屏幕以便陌生人跟随。
演示任务意外解决了这三点。您按产品强制要求的顺序执行步骤,前提条件因实际执行而出现,屏幕描述准确因为录制就是屏幕。
因此,对于可在屏幕上完成的任何内容,撰写优质软件文档的实用答案是:边旁白边做一次任务,然后编辑草稿而非面对空白页。Braiv 返回的是结构化内容——任务标题、编号操作、填充词已去除——您拥有的是判断:前提条件、警告、录制暗示但未展示的边界情况,以及产品术语表要求的措辞。
优质文档仍需要人决定什么重要。只是不需要人转录自己的点击。
同步比速度更重要
昂贵的失败不是文档慢,而是矛盾文档:文章描述的按钮视频已不再显示。从单一来源生成两者消除了这类 bug,而非围绕它排期。