序

近日老板吩咐寫一份碼云操作手冊。前前后后，兜兜轉(zhuǎn)轉(zhuǎn)，反復(fù)溝通，寫了三版稿子，才符合老板的要求。
以前沒寫過操作手冊，文檔也寫得不多，只有實(shí)施部署文檔寫得多一點(diǎn)。寫實(shí)施部署文檔，大多是在自身已經(jīng)掌握軟件的部署方法的情況下，記錄綜合軟件實(shí)施部署的過程。所以寫作起來，整體感覺很流暢，能較快捷的寫完。

而這次寫碼云操作手冊的情形是：碼云沒有用過，Git也僅了解過一點(diǎn)。所謂“Gitee操作手冊”，該怎么寫？寫什么內(nèi)容？完全不得要領(lǐng)。

如今手冊已順利交差，遂也總結(jié)一番，到底該如何寫操作手冊。

走過的歪路

第一版稿子，完全是Git的指令介紹。介紹諸如git clone指令怎么用，git commit怎么提交，提交后怎么解決合并沖突等等。

當(dāng)時(shí)為什么會(huì)這樣寫？我想著的是，Gitee操作手冊應(yīng)該告訴閱讀者，如何使用碼云結(jié)合Git管理代碼。所以操作者應(yīng)該熟知Git操作。于是第一版稿子的內(nèi)容即為Git的指令介紹了。

第一版稿子被老板打了回來，老板表示該版不是操作手冊，而我應(yīng)該也對碼云還不甚了解，應(yīng)當(dāng)先自己使用一番。體驗(yàn)一下如何使用碼云構(gòu)建企業(yè)項(xiàng)目，并進(jìn)行管理。再行編制操作手冊。

第二版稿子動(dòng)手之前，注冊了碼云企業(yè)版，結(jié)合碼云官方幫助手冊依樣畫葫蘆。結(jié)果寫操作手冊時(shí)，極大的受到了碼云幫助手冊的影響。碼云幫助手冊的特點(diǎn)是大而全，詳細(xì)介紹了各種操作，如何操作，從賬戶注冊到企業(yè)版本升級維護(hù)，第三方服務(wù)集成等等等等。而我的第二版手冊，等于是從碼云幫助手冊中，挑選除了企業(yè)版的操作介紹部分，結(jié)合一些自己感覺其他部分的也比較緊要的內(nèi)容。結(jié)果，也被老板打了回來。

老板的意見是，角色不清晰，作為閱讀者看完之后完全不知道該怎么辦。你的操作手冊應(yīng)當(dāng)告訴我，如果我是一個(gè)碼云開發(fā)者，我應(yīng)當(dāng)如何開發(fā)我的項(xiàng)目，如果我是一位管理員，應(yīng)該如何管理我的項(xiàng)目。

如何寫操作手冊

至第二版稿子完成之時(shí)，我應(yīng)當(dāng)算是對碼云有了一定的了解。兩版手冊都作廢的原因，我也思考了一番。結(jié)合老板的意見，所謂“Gitee操作手冊”，到底該怎么寫？到底該寫什么內(nèi)容？終于感覺撥開了云霧。

至少老板想要的操作手冊是這樣的。管理者讀了手冊，能一步一步的建立起碼云賬戶、企業(yè)項(xiàng)目管理企業(yè)成員。項(xiàng)目參與者讀了手冊，能知道自己如何一步一步加入道碼云，根據(jù)碼云任務(wù)系統(tǒng)，編碼、提交等。

總結(jié)

一份操作手冊如何去寫，不是要求大而全，不要不知所云，而要讓某個(gè)特定的角色能迅速找到自己想要的達(dá)到某種目的的操作方法步驟。所以文檔包含的內(nèi)容、結(jié)構(gòu)的編排都應(yīng)該為這一點(diǎn)服務(wù)。而在這之前，寫作者也應(yīng)代入角色親自體驗(yàn)一番如何操作。