服務(wù)說明文檔
對于每個服務(wù)而言，都應(yīng)有一個清晰的服務(wù)說明，描述當(dāng)前服務(wù)的信息，同時幫助團(tuán)隊(duì)更快腿解并快速上手。服務(wù)說明都包括如下幾個部分。
-
服務(wù)介紹
服務(wù)提供什么功能，譬如產(chǎn)品服務(wù)主要提供產(chǎn)品數(shù)據(jù)的獲取或者存儲。
誰是服務(wù)的消費(fèi)者。譬如產(chǎn)品服務(wù)的消費(fèi)者為電商的前端網(wǎng)站系統(tǒng)或者CRM系統(tǒng)。
-
服務(wù)維護(hù)者
- 挑選1-2個團(tuán)隊(duì)的成員，作為服務(wù)的負(fù)貴人，登記其姓名、電子郵件、電話等聯(lián)系方式，以便其他團(tuán)隊(duì)遇到問題能及時找到服務(wù)的負(fù)責(zé)人。
-
服務(wù)可用期
服務(wù)可用周期，如7X24小時，或周一?到周五（7:00?丨9:00)等。
可用率，可用率是指服務(wù)可以正常訪問的時間占總時間的百分比，如99.9%或者99%。
響應(yīng)時間，指服務(wù)返回?cái)?shù)據(jù)的可接受響應(yīng)時間。譬如為0.5-1秒
-
定義環(huán)境，描述服務(wù)運(yùn)行的具體環(huán)境，通常包括：
生產(chǎn)環(huán)境
測試環(huán)境
-
開發(fā)，描述開發(fā)相關(guān)的信息，通常包括：
如何搭建開發(fā)環(huán)境
如何運(yùn)行服務(wù)
如何定位問題
-
測試，描述測試相關(guān)的信息，通常包括：
測試策略
如何運(yùn)行測試
如何查看測試的統(tǒng)計(jì)結(jié)果，譬如測試覆蓋率、運(yùn)行時間、性能等。
-
構(gòu)建，描述持續(xù)集成以及構(gòu)建相關(guān)的信息，通常包括：
持續(xù)集成訪問的URL
持續(xù)集成的流程描述
構(gòu)建后的部署包
-
部署，描述部署相關(guān)的信息，通常包括：
如何部署到不同環(huán)境
部署后的功能驗(yàn)證
-
運(yùn)維，雛運(yùn)維相關(guān)的信息，通常包括：
日志聚合的訪問
告警信息的訪問
監(jiān)控信息的訪問
轉(zhuǎn)自：王磊的《微服務(wù)架構(gòu)與實(shí)踐》
