prd
技術(shù)文檔
風(fēng)險(xiǎn)跟蹤、溝通管理
績(jī)效管理
接口文檔
代碼規(guī)范
功能風(fēng)格
需求流程
越早理出必要的規(guī)范文檔、分配完成，越能保證質(zhì)量、減少矛盾。
每當(dāng)我們切入一個(gè)新項(xiàng)目時(shí)，我們發(fā)現(xiàn)項(xiàng)目中的文檔總是少的可憐，而且里面的設(shè)計(jì)與當(dāng)前的系統(tǒng)設(shè)計(jì)嚴(yán)重不符，有些甚至在架構(gòu)上出現(xiàn)了嚴(yán)重的偏離。于是我們問待交接人，為什么項(xiàng)目中只有這么點(diǎn)文檔，而且文檔的內(nèi)容也不準(zhǔn)確？他們振振有詞的告訴我們：這個(gè)項(xiàng)目的開發(fā)周期非常緊張，而且需求經(jīng)常發(fā)生變化，他們根本沒有時(shí)間去維護(hù)文檔，里面的那份文檔，是很久之前加班補(bǔ)的。要想看詳細(xì)的設(shè)計(jì)，就去看代碼吧，代碼就是最好的文檔。
? ? 聽到這里，有些人也許會(huì)以為項(xiàng)目中的代碼寫的多么的酷，每個(gè)類都是按照教科書中的格式體去注解的。但當(dāng)我們看完一個(gè)流程的代碼之后，就開始噴血。代碼中的注釋就像食堂免費(fèi)粥中的米粒一樣稀少，而有些注釋竟然是Todo體（Todo: ?YYYY年MM月DD日?Modified By XXX ?Invest some method to make it perfect）?？吹竭@，我們恨死了那該死的代碼就是文檔。面對(duì)這樣的項(xiàng)目，我們開始感嘆，為什么大家就不能規(guī)范一下自己的代碼呢？為什么不能多寫點(diǎn)文檔留給后來人呢？為什么當(dāng)初要死要活的換項(xiàng)目？
? ? 在這個(gè)項(xiàng)目上經(jīng)歷了無數(shù)個(gè)日夜的摧殘之后，終于有一天，我們要離開這個(gè)項(xiàng)目了。開始大喜，宴請(qǐng)四方同事，我們終于解放了，獲得自由了。以后再也不用看這個(gè)爛項(xiàng)目了。于是開始準(zhǔn)備交接工作，然后走人。
? ? 新來接手的同事看到項(xiàng)目上少的可憐的文檔，開始發(fā)問：?為什么項(xiàng)目中只有這么點(diǎn)文檔，而且文檔的內(nèi)容也不準(zhǔn)確？我們振振有詞的告訴他們：我們剛接手這個(gè)項(xiàng)目時(shí)，文檔比現(xiàn)在還要少，而且都是錯(cuò)的。這個(gè)項(xiàng)目開發(fā)周期緊，經(jīng)常加班，沒有時(shí)間去整理文檔。要看詳細(xì)的設(shè)計(jì)，就去看代碼吧，代碼就是最好的文檔。
? ? 代碼就是文檔，所有的程序員都聽?wèi)T了這句話，也恨透了這句話。因?yàn)檫@句話，幾乎傷害過每一個(gè)程序員。每當(dāng)看到不嚴(yán)謹(jǐn)?shù)淖⑨寱r(shí)，心里總是會(huì)先把這段程序罵一頓，然后再開始罵寫這段程序的人。我們總是覺得別人的代碼寫的不夠好，而自己的代碼寫的很嚴(yán)謹(jǐn)?？墒?，當(dāng)別人開始看我們的程序時(shí)，他們也總是把我們的代碼罵一頓，然后再來罵我們。這就是典型的程序員相輕。
? ? 代碼寫的不好也就算了，可是偏偏又沒有響應(yīng)的文檔，這叫人怎么可以忍受的了呢？每一個(gè)參與過敏捷開發(fā)的人，都知道項(xiàng)目的周期很緊，工作強(qiáng)度很大，在程序開發(fā)的某一個(gè)階段，可能真的沒有時(shí)間寫文檔。但是在項(xiàng)目的整個(gè)開發(fā)周期中，并不總是很忙的，如果想要寫文檔，肯定能找到時(shí)間的，如果說沒有時(shí)間寫文檔，那就是找借口。即使真的在工作時(shí)間沒有時(shí)間寫文檔，我們也應(yīng)該利用自己的時(shí)間去把這些設(shè)計(jì)文檔補(bǔ)上，這些文檔不但對(duì)于后來人的理解有很大的幫助。對(duì)于自己來說，也是有莫大的幫助，這些文檔能夠幫助我們更好的理解這個(gè)項(xiàng)目。
? ? 作為開發(fā)人員，請(qǐng)不要抱怨項(xiàng)目沒有文檔。如果項(xiàng)目沒有文檔，我們應(yīng)該及時(shí)的補(bǔ)上這些文檔，并用這個(gè)好習(xí)慣去影響別人，并傳遞給別人。如果人人都不偷懶，認(rèn)真寫文檔。那時(shí)候，項(xiàng)目就不再缺少文檔，我們也不用苦苦去看代碼，不用為代碼就是文檔而發(fā)愁。給別人鋪路，就是給自己鋪路。讓我們嚴(yán)格要求自己，從傳遞文檔開始做起，讓程序員的世界越來越美好。
