【Topic-based writing】 安装手册经典作品点评

打算动手安装一套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
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 175,660评论 25 709
  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 14,223评论 4 61
  • 从小到大,我们一直在不同的圈子中生活。 小学四年级之前,我在老家上学,那时候小,不会交朋友,更没有圈子,那时候的记...
    joanna哈哈哈哈阅读 2,622评论 0 1
  • 新的时代赋予铁路人新的使命,新的改革发展有了更全面的方向。钢铁长龙蜿蜒匍匐在中华大地,铮铮铁骨挥汗如雨滴落在茫茫...
    徐嘉豪阅读 1,521评论 0 0
  • 记忆中,关于奶奶的画面:斜着绕头绑一条约么10mm的黑绳(把松弛的双眼皮拉起来,否则挡住眼睛,影响视线),樱桃小嘴...
    Amyuyu阅读 1,235评论 0 0