不知道大家對寫文檔是一種什么樣的感受狂票,但在我周邊的這些小伙伴們欠痴,如果要讓他們寫文檔耸弄,這好像成了一個大難題咧虎,原本有個項(xiàng)目還有一個功能需要完成的。
當(dāng)負(fù)責(zé)項(xiàng)目的同事跟我說计呈,你要不要幫我們完成一下某個功能時砰诵,我和她商量說征唬,最近不是讓寫驗(yàn)收文檔么?那文檔到時候交給你來寫好不好茁彭。結(jié)果同事說总寒,你還是寫文檔吧。
其實(shí)對我而言理肺,無論那個工作摄闸,都必須要接,盡管我可能對這個項(xiàng)目的整體流程妹萨,甚至是功能都不熟悉年枕,但無論拿到哪項(xiàng)工作,對我們來說乎完,都必須完成熏兄。
好在寫文檔對我,可能相對簡單一些囱怕,因?yàn)橹白鲞^別的項(xiàng)目驗(yàn)收的文檔霍弹,而關(guān)于寫文檔的難點(diǎn)就在于,對系統(tǒng)的流程及功能都不熟悉娃弓,我需要自己先熟悉系統(tǒng)典格,然后才有可能寫出需要的相關(guān)文檔。
也是因?yàn)閷?xiàng)目的陌生台丛,我選擇了從數(shù)據(jù)庫設(shè)計開始耍缴,因?yàn)闊o論那個系統(tǒng),先搞明白數(shù)據(jù)結(jié)構(gòu)挽霉,系統(tǒng)的大致功能也就差不多防嗡,只不過,這是一種反向操作侠坎,通過結(jié)果找過程蚁趁。
盡管這種方式看起來不是很友好,但我還是選擇了從這部分工作開始实胸,好在經(jīng)過幾天的打磨他嫡,關(guān)于數(shù)據(jù)庫設(shè)計的這部分文檔,基本上已經(jīng)編寫完成庐完。今天開始的部分钢属,則屬于功能設(shè)計,而寫到這部分功能门躯,那就不得不先熟悉系統(tǒng)的需求和原型設(shè)計了淆党。
早上到單位之后,我打開了系統(tǒng),找到了原型設(shè)計染乌,好在上周產(chǎn)品的小伙伴還給了我一份系統(tǒng)用戶操作手冊山孔,結(jié)合這些資料,我從用戶操作手冊入手荷憋,大致知道了系統(tǒng)角色及操作的主要流程饱须。
然后又看了系統(tǒng)原型設(shè)計的需求,說實(shí)話台谊,密密麻麻的文字需求,真的是看的人直犯困譬挚,但好在锅铅,一上午的時間,我大致看完了幾個階段主要的原型設(shè)計及產(chǎn)品描述减宣。
到下午盐须,基本上就不得不開始設(shè)計文檔的編寫,我修改了文檔中漆腌,各個我覺得還可以調(diào)整的部分贼邓,唯獨(dú)避開了功能設(shè)計部分,但等我處理完一切闷尿,只剩下功能設(shè)計時塑径。
我也不得不結(jié)合系統(tǒng),根據(jù)實(shí)際功能開始寫功能設(shè)計的部分填具,任何系統(tǒng)都有的部分是系統(tǒng)的基礎(chǔ)配置用戶管理體系统舀,于是我從用戶的管理體系開始,先編寫完了用戶管理部分的功能設(shè)計劳景。
在對改完這一部分文檔的整體框架及目錄結(jié)構(gòu)進(jìn)行了一番簡單的梳理之后誉简,其他部分的功能設(shè)計,雖然還沒有開始編寫盟广,但已經(jīng)有了大致的編寫思路闷串。
我想這大概就是人們常說的,萬事開頭難的原因吧筋量!因?yàn)樾麻_始任何的東西烹吵,我們都沒有什么思路和想法。
一旦我們梳理出了開頭第一步的大框架毛甲,那么接下來的步驟年叮,都是自然而然的。