又见一本手册典范--《Magento安装手册》结构评点
2017-11-17 本文已影响53人
Joy的未来十年
打算动手安装一套Magento，定位到它的英文社区，里面有安装手册（http://devdocs.magento.com/guides/v2.2/install-gde/bk-install-guide.html）。不自觉地研究起手册的结构与组织，是一本优秀的安装手册。以下我列出让我欣喜可以学习到的表达与组织方法：
-
安装手册从outline到里面的内容组织，都很清晰明了，实用性强
image.png
-
分不同用户需求，以表格方式给出不同的安装概述。
image.png
-
安装流程图--安装流程的步骤中嵌套着子步骤，横向流程图描述大步骤，纵向流程图描述子步骤。这张安装图，让读者通过一张图，对安装的大小步骤都有了全局认识。
image.png
【对比与借鉴】
-
以下是我写的《大数据平台安装手册》中给出的流程图，左图是总体流程图，右图是在各章中给出的子步骤流程图。假使大步骤少一点的话，也可以借鉴Magento的方法，把两者结合在一张图中。
image.png
-
我的文档结构也不错--我司平台的安装是单线条式，不像Magento的针对几类用户多线条。
image.png
对于第八章，我自己挺满意，通过两个星期的反复安装，积累了一些经验，形成一个独立章节。虽内容有待丰满，但它的存在让安装手册从结构上圆满了。-- 这一点通过《Magento安装手册》，也找到了共鸣。
image.png
