程序員的README

第 1 章 前面的旅程 1
1.1 你的目的地 1
1.2 你的旅程地圖 2
1.2.1 新手營 3
1.2.2 試煉之河 5
1.2.3 貢獻(xiàn)者之角 5
1.2.4 運維之海 6
1.2.5 勝任之灣 6
1.3 前進(jìn)！ 7

第 2 章 步入自覺階段 8
2.1 學(xué)習(xí)如何學(xué)習(xí) 9
2.1.1 前置學(xué)習(xí) 9
2.1.2 在實踐中學(xué)習(xí) 9
2.1.3 運行實例代碼 11
2.1.4 閱讀 11
2.1.5 觀看講座 13
2.1.6 適度地參加會議和聚會 14
2.1.7 跟班學(xué)習(xí)并同有經(jīng)驗的工程師結(jié)對 15
2.1.8 用副業(yè)項目實踐 16
2.2 提出問題 17
2.2.1 動手調(diào)查一下 17
2.2.2 設(shè)置一個時間限制 17
2.2.3 寫下全過程 18
2.2.4 別打擾別人 19
2.2.5 多用“非打擾式”交流 20
2.2.6 批量處理你的同步請求 20
2.3 克服成長的障礙 21
2.3.1 冒充者綜合征 21
2.3.2 鄧寧-克魯格效應(yīng) 22
2.4 行為準(zhǔn)則 23
2.5 升級加油站 23

第3 章 玩轉(zhuǎn)代碼 25
3.1 軟件的熵 26
3.2 技術(shù)債 26
3.3 變更代碼 29
3.3.1 善于利用現(xiàn)有代碼 30
3.3.2 過手的代碼要比之前更干凈 32
3.3.3 做漸變式的修改 33
3.3.4 對重構(gòu)要務(wù)實 33
3.3.5 善用IDE 34
3.3.6 請使用VCS 的實踐 34
3.4 避“坑”指南 35
3.4.1 保守一些的技術(shù)選型 36
3.4.2 不要特立獨行 39
3.4.3 不要只分叉而不向上游提交修改 40
3.4.4 克制重構(gòu)的沖動 40
3.5 行為準(zhǔn)則 42
3.6 升級加油站 42

第4 章 編寫可維護(hù)的代碼 44
4.1 防御式編程 45
4.1.1 避免空值 45
4.1.2 保持變量不可變 46
4.1.3 使用類型提示和靜態(tài)類型檢查器 46
4.1.4 驗證輸入 47
4.1.5 善用異常 49
4.1.6 異常要有精確含義 50
4.1.7 早拋晚捕 51
4.1.8 智能重試 52
4.1.9 構(gòu)建冪等系統(tǒng) 53
4.1.10 及時釋放資源 53
4.2 關(guān)于日志的使用 54
4.2.1 給日志分級 55
4.2.2 日志的原子性 56
4.2.3 關(guān)注日志性能 57
4.2.4 不要記錄敏感數(shù)據(jù) 59
4.3 系統(tǒng)監(jiān)控 59
4.3.1 使用標(biāo)準(zhǔn)的監(jiān)控組件 60
4.3.2 測量一切 63
4.4 跟蹤器 64
4.5 配置相關(guān)注意事項 64
4.5.1 配置無須新花樣 65
4.5.2 記錄并校驗所有的配置 66
4.5.3 提供默認(rèn)值 67
4.5.4 給配置分組 67
4.5.5 將配置視為代碼 67
4.5.6 保持配置文件清爽 68
4.5.7 不要編輯已經(jīng)部署的配置 68
4.6 工具集 68
4.7 行為準(zhǔn)則 70
4.8 升級加油站 71

第5 章 依賴管理 72
5.1 依賴管理基礎(chǔ)知識 73
5.1.1 語義化版本 74
5.1.2 傳遞依賴 75
5.2 相依性地獄 76
5.3 避免相依性地獄 80
5.3.1 隔離依賴項 80
5.3.2 按需添加依賴項 81
5.3.3 指定依賴項的版本 82
5.3.4 依賴范圍小化 84
5.3.5 保護(hù)自己免受循環(huán)依賴的影響 84
5.4 行為準(zhǔn)則 85
5.5 升級加油站 85

第6 章 測試 87
6.1 測試的多種用途 87
6.2 測試類型 88
6.3 測試工具 91
6.3.1 模擬庫 91
6.3.2 測試框架 92
6.3.3 代碼質(zhì)量工具 93
6.4 自己動手編寫測試 95
6.4.1 編寫干凈的測試 95
6.4.2 避免過度測試 96
6.5 測試中的確定性 98
6.5.1 種子隨機數(shù)生成器 99
6.5.2 不要在單元測試中調(diào)用遠(yuǎn)程系統(tǒng) 99
6.5.3 采用注入式時間戳 99
6.5.4 避免使用休眠和超時 102
6.5.5 記得關(guān)閉網(wǎng)絡(luò)套接字和文件句柄 102
6.5.6 綁定到0 端口 103
6.5.7 生成的文件路徑和數(shù)據(jù)庫位置 103
6.5.8 隔離并清理剩余的測試狀態(tài) 103
6.5.9 不要依賴測試順序 104
6.6 行為準(zhǔn)則 105
6.7 升級加油站 105

第7 章 代碼評審 107
7.1 為什么需要評審代碼 107
7.2 當(dāng)你的代碼被評審時 109
7.2.1 準(zhǔn)備工作 109
7.2.2 用評審草案降低風(fēng)險 110
7.2.3 提交評審請勿觸發(fā)測試 111
7.2.4 預(yù)排大體量的代碼修改 111
7.2.5 不要太在意 112
7.2.6 保持同理心，但不要容忍粗魯 113
7.2.7 保持主動 113
7.3 評審別人的代碼時 114
7.3.1 分流評審請求 114
7.3.2 給評審預(yù)留時間 114
7.3.3 理解修改的意圖 115
7.3.4 提供全面的反饋 115
7.3.5 要承認(rèn)優(yōu)點 116
7.3.6 區(qū)分問題、建議和挑剔 116
7.3.7 不要只做橡皮圖章 117
7.3.8 不要只局限于使用網(wǎng)頁版的評審工具 118
7.3.9 不要忘記評審測試代碼 118
7.3.10 推動決斷 118
7.4 行為準(zhǔn)則 119
7.5 升級加油站 120

第8 章 軟件交付 121
8.1 軟件交付流程 121
8.2 分支策略 122
8.3 構(gòu)建環(huán)節(jié) 125
8.3.1 打包需要帶版本號 126
8.3.2 將不同的資源單獨打包 127
8.4 發(fā)布環(huán)節(jié) 129
8.4.1 請勿只想著發(fā)布 129
8.4.2 將包發(fā)布到倉庫 130
8.4.3 保持版本不變性 131
8.4.4 頻繁發(fā)布 131
8.4.5 對發(fā)布計劃保持透明 132
8.4.6 撰寫變更日志和發(fā)行說明 132
8.5 部署環(huán)節(jié) 133
8.5.1 自動部署 133
8.5.2 部署的原子性 134
8.5.3 獨立地部署應(yīng)用 134
8.6 展開環(huán)節(jié) 136
8.6.1 系統(tǒng)監(jiān)控 137
8.6.2 特性開關(guān) 137
8.6.3 熔斷器 138
8.6.4 并行的服務(wù)版本梯隊 139
8.6.5 摸黑啟動 141
8.7 行為準(zhǔn)則 143
8.8 升級加油站 144

第9 章 On-Call 146
9.1 On-Call 的工作方式 147
9.2 On-Call 技能包 148
9.2.1 隨時響應(yīng) 148
9.2.2 保持專注 148
9.2.3 確定工作優(yōu)先級 149
9.2.4 清晰的溝通 150
9.2.5 跟蹤你的工作 151
9.3 事故處理 152
9.3.1 分流 153
9.3.2 協(xié)同 154
9.3.3 應(yīng)急方案 155
9.3.4 解決方案 157
9.3.5 后續(xù)行動 159
9.4 提供支持 162
9.5 不要逞英雄 164
9.6 行為準(zhǔn)則 165
9.7 升級加油站 165

第 10 章 技術(shù)設(shè)計流程 167
10.1 技術(shù)設(shè)計的V 形結(jié)構(gòu) 168
10.2 關(guān)于設(shè)計的思考 169
10.2.1 定義問題 170
10.2.2 著手調(diào)查 171
10.2.3 進(jìn)行實驗 172
10.2.4 給些時間 173
10.3 撰寫設(shè)計文檔 174
10.3.1 文檔持續(xù)變更 174
10.3.2 了解撰寫文檔的目的 175
10.3.3 學(xué)會寫作 176
10.3.4 保證文檔是的 176
10.4 使用設(shè)計文檔模板 177
10.4.1 概要 178
10.4.2 現(xiàn)狀與背景 178
10.4.3 變更的目的 178
10.4.4 需求 179
10.4.5 潛在的解決方案 179
10.4.6 建議的解決方案 180
10.4.7 設(shè)計與架構(gòu) 180
10.4.8 測試計劃 181
10.4.9 發(fā)布計劃 181
10.4.10 遺留的問題 181
10.4.11 附錄 181
10.5 協(xié)作設(shè)計 182
10.5.1 理解你的團(tuán)隊的設(shè)計評審流程 182
10.5.2 不要讓人驚訝 183
10.5.3 用設(shè)計討論來進(jìn)行頭腦風(fēng)暴 183
10.5.4 為設(shè)計出力 184
10.6 行為準(zhǔn)則 185
10.7 升級加油站 185

第 11 章 構(gòu)建可演進(jìn)的架構(gòu) 187
11.1 理解復(fù)雜性 188
11.2 可演進(jìn)的設(shè)計 189
11.2.1 你不是真的需要 189
11.2.2 小驚訝原則 191
11.2.3 封裝專業(yè)領(lǐng)域知識 193
11.3 可演進(jìn)的API 193
11.3.1 保持API 小巧 194
11.3.2 公開定義良好的服務(wù)端API 194
11.3.3 保持API 變更的兼容性 195
11.3.4 API 版本化 198
11.4 可持續(xù)的數(shù)據(jù)管理 199
11.4.1 數(shù)據(jù)庫隔離 199
11.4.2 使用schema 201
11.4.3 schema 自動化遷移 203
11.4.4 保持schema 的兼容性 206
11.5 行為準(zhǔn)則 207
11.6 升級加油站 208

第 12 章 敏捷計劃 210
12.1 敏捷宣言 210
12.2 敏捷計劃的框架 211
12.3 Scrum 框架 212
12.3.1 用戶故事 213
12.3.2 任務(wù)分解 214
12.3.3 故事點 214
12.3.4 消化積壓 216
12.3.5 沖刺計劃 216
12.4 站會 217
12.5 評審機制 218
12.6 回顧會 219
12.7 路線圖 220
12.8 行為準(zhǔn)則 221
12.9 升級加油站 222

第 13 章 與管理者合作 223
13.1 管理者是做什么的 223
13.2 溝通、目標(biāo)與成長 224
13.2.1 一對一面談 225
13.2.2 PPP 227
13.2.3 OKR 229
13.2.4 績效考核 230
13.3 向上管理 232
13.3.1 接收反饋 232
13.3.2 給予反饋 233
13.3.3 討論你的目標(biāo) 235
13.3.4 事情不順時要采取行動 236
13.4 行為準(zhǔn)則 238
13.5 升級加油站 239

第 14 章 職業(yè)生涯規(guī)劃 241
14.1 邁向資深之路 241
14.2 職業(yè)生涯建議 242
14.2.1 T 型人才 242
14.2.2 參加工程師訓(xùn)練營 243
14.2.3 主導(dǎo)你自己的晉升 244
14.2.4 換工作需謹(jǐn)慎 246
14.2.5 自我調(diào)節(jié) 247
14.3 結(jié)尾寄語 248