軟硬件環境配置文檔的閱讀與編寫注意事項

在閱讀一篇文檔時,如果其中涉及了較多的、詳細的配置步驟,則進行粗讀即可。因爲具體的配置步驟如果太長,在沒有實際的操作環境下進行閱讀,最多就是在腦中走一遍流程,看完之後過不了多久就會遺忘許多細節。因此,花較多時間看配置步驟的效率會比較低。

與此相反,如果由自己着手進行某個軟硬件環境的配置,那麼需要在第一時間就編寫相關的配置手冊(大綱),以免遺忘相關步驟或不必要的重複工作。初次搭建時可以僅通過大綱的方式對配置過程進行粗略記錄(描述),等環境搭建完畢、功能全部完善後再對文檔進行詳細的修訂。

編寫配置(說明)手冊等文檔時,最重要的就是要站在文檔實際閱讀者的角度進行編寫(描述)。應該首先假設文檔閱讀者對文檔描述內容的瞭解程度爲零,然後按照step by step的粒度對配置過程按步驟、分章進行描述。描述時應該添加必要的插圖與表格,相關專用名詞應該單獨成章加以說明,相關參考資料要按附錄形式添加到文檔末尾,以最大可能地減少閱讀者(包括文檔編寫人自己在內)對相關資料的重複查閱工作。

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