软硬件环境配置文档的阅读与编写注意事项

在阅读一篇文档时,如果其中涉及了较多的、详细的配置步骤,则进行粗读即可。因为具体的配置步骤如果太长,在没有实际的操作环境下进行阅读,最多就是在脑中走一遍流程,看完之后过不了多久就会遗忘许多细节。因此,花较多时间看配置步骤的效率会比较低。

与此相反,如果由自己着手进行某个软硬件环境的配置,那么需要在第一时间就编写相关的配置手册(大纲),以免遗忘相关步骤或不必要的重复工作。初次搭建时可以仅通过大纲的方式对配置过程进行粗略记录(描述),等环境搭建完毕、功能全部完善后再对文档进行详细的修订。

编写配置(说明)手册等文档时,最重要的就是要站在文档实际阅读者的角度进行编写(描述)。应该首先假设文档阅读者对文档描述内容的了解程度为零,然后按照step by step的粒度对配置过程按步骤、分章进行描述。描述时应该添加必要的插图与表格,相关专用名词应该单独成章加以说明,相关参考资料要按附录形式添加到文档末尾,以最大可能地减少阅读者(包括文档编写人自己在内)对相关资料的重复查阅工作。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章