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