如果您负责编写应该指导他人如何做某事的文档,那么今天的做事方式或多或少会把旧方法抛在脑后。
1.大爆炸头
您会注意到PCMech上的标题很大,例如这句话的右边。 这是因为它们更容易查看,阅读和了解您在文档中的位置。
2.少话
错误的方法:
以下文档说明了如何使用和操作Fanny Whacker 2000。
正确的路:
有关如何使用Fanny Whacker 2000的说明
编写文档时,请始终记住以下短语:尽可能快地到达要点。
3.跳过无用的引用
如果引用与您要描述的内容的核心说明无关,例如:
有关Fanny Whacker 2000的Turnip Twaddler的更多信息,请参阅文件FU,ID10T小节。
…不要那样做。
4.约会。 总是。
文档的撰写日期应在每页的页脚区域中。 如果是电子文档,则日期显示两次。 一次开始,一次结束。
您可以将其写为“最新修订(在此处插入日期)”。
5.警告应始终贴在不可退还的点之前
如果您的文档中有某些内容,如果执行不正确,可能会损坏/毁坏/清除某些内容,则应将这些信息直接放在所述说明之后,以清楚的眼光(在同一页上表示)并强调。
例:
步骤5.清洁Fanny Whacker 2000
FW2000的拨片应使用非研磨性软布轻轻清洁。
警告:只能使用不含氨的溶剂来防止FW2000爆炸并导致您过早的死亡。
最后要说的是,好的文档并不是对可想像到的每件事都具有超级描述性。 阅读您的文档并问自己,它是否正确指示? 如果答案是肯定的,那么下一个问题是,它会 迅速 发出指示吗? 如果是,则说明文件很好。