打算動(dòng)手安裝一套Magento,定位到它的英文社區(qū),里面有安裝手冊(cè)(http://devdocs.magento.com/guides/v2.2/install-gde/bk-install-guide.html)。不自覺(jué)地研究起手冊(cè)的結(jié)構(gòu)與組織,是一本優(yōu)秀的安裝手冊(cè)。以下我列出讓我欣喜可以學(xué)習(xí)到的表達(dá)與組織方法:
-
安裝手冊(cè)從outline到里面的內(nèi)容組織,都很清晰明了,實(shí)用性強(qiáng)
image.png -
分不同用戶需求,以表格方式給出不同的安裝概述。
image.png -
安裝流程圖--安裝流程的步驟中嵌套著子步驟,橫向流程圖描述大步驟,縱向流程圖描述子步驟。這張安裝圖,讓讀者通過(guò)一張圖,對(duì)安裝的大小步驟都有了全局認(rèn)識(shí)。
image.png
【對(duì)比與借鑒】
-
以下是我寫(xiě)的《大數(shù)據(jù)平臺(tái)安裝手冊(cè)》中給出的流程圖,左圖是總體流程圖,右圖是在各章中給出的子步驟流程圖。假使大步驟少一點(diǎn)的話,也可以借鑒Magento的方法,把兩者結(jié)合在一張圖中。
image.png -
我的文檔結(jié)構(gòu)也不錯(cuò)--我司平臺(tái)的安裝是單線條式,不像Magento的針對(duì)幾類(lèi)用戶多線條。
image.png
對(duì)于第八章,我自己挺滿意,通過(guò)兩個(gè)星期的反復(fù)安裝,積累了一些經(jīng)驗(yàn),形成一個(gè)獨(dú)立章節(jié)。雖內(nèi)容有待豐滿,但它的存在讓安裝手冊(cè)從結(jié)構(gòu)上圓滿了。-- 這一點(diǎn)通過(guò)《Magento安裝手冊(cè)》,也找到了共鳴。
image.png





