week15

本周的心得是寫(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ì)更加方便舔示。


圖片發(fā)自簡(jiǎn)書(shū)App


我已經(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é)得挺滿意扑浸。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末烧给,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子喝噪,更是在濱河造成了極大的恐慌础嫡,老刑警劉巖,帶你破解...
    沈念sama閱讀 222,000評(píng)論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件酝惧,死亡現(xiàn)場(chǎng)離奇詭異榴鼎,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)晚唇,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,745評(píng)論 3 399
  • 文/潘曉璐 我一進(jìn)店門(mén)巫财,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人哩陕,你說(shuō)我怎么就攤上這事平项×憔郏” “怎么了渣磷?”我有些...
    開(kāi)封第一講書(shū)人閱讀 168,561評(píng)論 0 360
  • 文/不壞的土叔 我叫張陵缎除,是天一觀的道長(zhǎng)凛捏。 經(jīng)常有香客問(wèn)我,道長(zhǎng)规肴,這世上最難降的妖魔是什么鲁冯? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 59,782評(píng)論 1 298
  • 正文 為了忘掉前任垃帅,我火速辦了婚禮缨叫,結(jié)果婚禮上椭符,老公的妹妹穿的比我還像新娘。我一直安慰自己耻姥,他們只是感情好销钝,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,798評(píng)論 6 397
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著琐簇,像睡著了一般曙搬。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上鸽嫂,一...
    開(kāi)封第一講書(shū)人閱讀 52,394評(píng)論 1 310
  • 那天,我揣著相機(jī)與錄音征讲,去河邊找鬼据某。 笑死,一個(gè)胖子當(dāng)著我的面吹牛诗箍,可吹牛的內(nèi)容都是我干的癣籽。 我是一名探鬼主播,決...
    沈念sama閱讀 40,952評(píng)論 3 421
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼筷狼!你這毒婦竟也來(lái)了瓶籽?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 39,852評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤埂材,失蹤者是張志新(化名)和其女友劉穎塑顺,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體俏险,經(jīng)...
    沈念sama閱讀 46,409評(píng)論 1 318
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡严拒,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,483評(píng)論 3 341
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了竖独。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片裤唠。...
    茶點(diǎn)故事閱讀 40,615評(píng)論 1 352
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖莹痢,靈堂內(nèi)的尸體忽然破棺而出种蘸,到底是詐尸還是另有隱情,我是刑警寧澤竞膳,帶...
    沈念sama閱讀 36,303評(píng)論 5 350
  • 正文 年R本政府宣布航瞭,位于F島的核電站,受9級(jí)特大地震影響顶猜,放射性物質(zhì)發(fā)生泄漏沧奴。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,979評(píng)論 3 334
  • 文/蒙蒙 一长窄、第九天 我趴在偏房一處隱蔽的房頂上張望滔吠。 院中可真熱鬧,春花似錦挠日、人聲如沸疮绷。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 32,470評(píng)論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)冬骚。三九已至,卻和暖如春懂算,著一層夾襖步出監(jiān)牢的瞬間只冻,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,571評(píng)論 1 272
  • 我被黑心中介騙來(lái)泰國(guó)打工计技, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留喜德,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 49,041評(píng)論 3 377
  • 正文 我出身青樓垮媒,卻偏偏與公主長(zhǎng)得像舍悯,于是被迫代替她去往敵國(guó)和親航棱。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,630評(píng)論 2 359

推薦閱讀更多精彩內(nèi)容