本周的心得是寫(xiě)文檔汉买。
同事突然因病請(qǐng)假衔峰,得找一個(gè)人接替。測(cè)試工作的簡(jiǎn)單之處在于,上手非车媛保快威彰,軟件都是做出來(lái)給人用的,沒(méi)理由研讀三天文檔才能開(kāi)始穴肘。而更重要的理由是歇盼,由于敏捷開(kāi)發(fā),所有人都懶得寫(xiě)文檔评抚,東一塊豹缀,西一塊的,壓根兒沒(méi)有結(jié)構(gòu)清楚慨代,更新及時(shí)的文檔邢笙。當(dāng)然,也不是完全沒(méi)有文檔的侍匙,公司負(fù)責(zé)CMMI3評(píng)審的經(jīng)理就不止一次的對(duì)我說(shuō)氮惯,我們部門(mén)的文檔管理已經(jīng)算很好了(因?yàn)槲业牟块T(mén)比較小,因此CMMI每年一小評(píng)想暗,三年一大評(píng))妇汗。如果組織上要求不明確,則想寫(xiě)就寫(xiě)说莫,自由發(fā)揮的空間比較大杨箭,文檔好或者爛,多或者寡唬滑,完全依賴(lài)于寫(xiě)作者的水平告唆,以及閱讀者的期待。我花了一天的時(shí)間整理好文檔晶密,分享給需要接手工作的同事。有幾點(diǎn)心得:
第一模她,文檔存放的位置最好統(tǒng)一稻艰。我們的文檔顯得復(fù)雜,是因?yàn)橛形臋n分散在不同的地方侈净,jira尊勿,git,google doc畜侦,郵件元扔,公司的平臺(tái),測(cè)試管理工具旋膳,等等澎语,還有各種環(huán)境數(shù)據(jù)庫(kù),簡(jiǎn)直是要瘋。對(duì)于新接觸項(xiàng)目的人擅羞,分分鐘要瘋尸变。
第二,文檔的內(nèi)容應(yīng)盡量準(zhǔn)確减俏。有的文檔已經(jīng)過(guò)時(shí)了召烂,有的沒(méi)有反映實(shí)際情況。比如對(duì)于大的項(xiàng)目娃承,設(shè)計(jì)文檔寫(xiě)得都挺漂亮的奏夫,但實(shí)際實(shí)現(xiàn)有調(diào)整了,真是沒(méi)處找历筝。
第三酗昼,文檔需要有人經(jīng)常整理。就像房間一樣漫谷,雖然搜索功能已經(jīng)做的比較方便了仔雷,但是如果有一個(gè)主線的話,閱讀和檢索就會(huì)更加方便舔示。
我已經(jīng)在這個(gè)組織很多年了碟婆,大腦里自有一套知識(shí)系統(tǒng)。有新人入職的話惕稻,總會(huì)就文檔問(wèn)題有所困惑竖共,解釋以后新同事就慢慢適應(yīng)了。細(xì)想起來(lái)俺祠,我們的文檔還是有很多值得改進(jìn)的地方公给,以上三條說(shuō)起來(lái)容易,項(xiàng)目一多蜘渣,事情一忙淌铐,既沒(méi)有規(guī)范也沒(méi)有人專(zhuān)門(mén)負(fù)責(zé),時(shí)間長(zhǎng)了蔫缸,就像一個(gè)沒(méi)有維護(hù)的花園腿准,也很豐富,缺了一點(diǎn)美感拾碌。
我最近在給娃寫(xiě)一份《武功秘籍》吐葱,起因是他和同學(xué)為小事打了架被老師教育,難過(guò)傷心不服氣校翔。為了顯示秘籍的珍貴弟跑,我故意收了他50元。現(xiàn)在已經(jīng)寫(xiě)到第五章防症,分別是:
1)和同學(xué)鬧矛盾怎么辦
2)IQ孟辑,EQ和AQ
3)好好說(shuō)話
4)時(shí)間都去哪兒了
5)學(xué)會(huì)學(xué)習(xí)
因?yàn)楦读隋X(qián)哎甲,娃還挺當(dāng)回事的,我也覺(jué)得挺滿意扑浸。