每個(gè)人都要求別人要寫(xiě)詳細(xì)的文檔男旗，但是自己又討厭寫(xiě)文檔球散。除了寫(xiě)文檔特別麻煩之外，還有就是怕自己的思想精華被別人吸收添忘。文檔寫(xiě)起來(lái)采呐，可能會(huì)比開(kāi)發(fā)代碼多幾倍的時(shí)間，甚至是在一些文采蹩腳的人的腦中搁骑，根本無(wú)從下手斧吐。一些設(shè)計(jì)文檔，代碼文檔仲器，產(chǎn)品文檔煤率，都是項(xiàng)目中的精華。
己所不欲乏冀，勿施于人蝶糯。當(dāng)你沉下心來(lái)寫(xiě)文檔的時(shí)候，同時(shí)你也會(huì)要求你的下級(jí)或者你身邊的同事來(lái)一起完善這方面辆沦。所以多思考昼捍，誰(shuí)會(huì)讀你的文檔，他們的水平怎么樣肢扯，能夠接受你文檔里的東西嗎妒茬，或者說(shuō)從哪些方面能夠更引人入勝。
其實(shí)蔚晨，從某個(gè)角度來(lái)講乍钻，代碼也是文檔，而且嚴(yán)格來(lái)說(shuō)铭腕，代碼就是技術(shù)最高文檔的升華提煉银择。一個(gè)程序員如果懂得寫(xiě)詳細(xì)的文檔，那么在由文檔去寫(xiě)代碼都是事半功倍谨履，因?yàn)橹皇且粋€(gè)把文檔翻譯成代碼的過(guò)程欢摄。正如你同時(shí)會(huì)中文和英文熬丧，寫(xiě)好中文后笋粟，在用一定的時(shí)間把中文翻譯成英文一樣怀挠。
對(duì)于大公司，特別注重流程化管理害捕。大都數(shù)的管理員都是堅(jiān)信詳細(xì)的文檔就是流程化的保證绿淋。不存在有個(gè)大拿把控一切，不存在有人說(shuō)離開(kāi)了這個(gè)技術(shù)大拿尝盼，產(chǎn)品就造不出來(lái)吞滞，公司就無(wú)法運(yùn)營(yíng)下去，這是錯(cuò)誤的思想盾沫。所以管控優(yōu)秀的文檔裁赠，人沒(méi)了繼續(xù)招人，公司就像鐵打的營(yíng)盤(pán)赴精，員工就是流水佩捞，一波一波的換來(lái)?yè)Q去，公司永不倒蕾哟。
當(dāng)然一忱，對(duì)于個(gè)人來(lái)講，如果你不想讓你的思想暴露出來(lái)谭确，同時(shí)上司又要求你規(guī)范文檔帘营，那么你完全可以寫(xiě)得含蓄一些，代碼里不要寫(xiě)注釋?zhuān)炎约旱倪壿嫳磉_(dá)的婉轉(zhuǎn)一些逐哈。對(duì)于一個(gè)負(fù)責(zé)人的程序員芬迄，可能對(duì)你的要求是這樣的。
編寫(xiě)的代碼文檔非常標(biāo)準(zhǔn)規(guī)范（可以不寫(xiě)注釋?zhuān)┚厦迹枰愕念^文件和源文件按照代碼規(guī)范來(lái)寫(xiě)薯鼠，優(yōu)秀的命名規(guī)則，折疊伸縮有序械蹋，段落合理出皇，代碼優(yōu)雅，那么我覺(jué)得要不要寫(xiě)注釋沒(méi)那么重要哗戈。
簡(jiǎn)單清晰的架構(gòu)設(shè)計(jì)文檔郊艘。你可以用簡(jiǎn)單的流程圖，或者思維導(dǎo)圖唯咬，不要求你畫(huà)很多框框纱注，但是可能你需要言簡(jiǎn)意賅。
編寫(xiě)給別人看的代碼胆胰，比如SDK上的api函數(shù)名狞贱。為讀者和客戶(hù)考慮，把你珍貴的時(shí)間花在讓他更加容易閱讀的事情上蜀涨。
