互聯(lián)網(wǎng)軟件全套文檔 產(chǎn)品技術(shù)測試運(yùn)維項(xiàng)目

互聯(lián)網(wǎng)/軟件全套文檔：產(chǎn)品、技術(shù)、測試、運(yùn)維、項(xiàng)目前言簡約文檔可提高團(tuán)隊(duì)溝通效率；詳細(xì)文檔體系可形成無形價(jià)值資產(chǎn)，比如降低人員培養(yǎng)周期。所有文檔列表都是基于實(shí)際產(chǎn)品、項(xiàng)目情況而定，最好在決定做一個(gè)新產(chǎn)品，或?qū)嵤┮粋€(gè)項(xiàng)目時(shí)，就根據(jù)實(shí)際情況拉出一張需要輸出的文檔列表。產(chǎn)品管理文檔列表市場調(diào)研文檔：1、行業(yè)分析，包括市場規(guī)模、常見盈利模式、增長態(tài)勢等；2、同行業(yè)分析，包括行業(yè)細(xì)分賽道，比如如在線旅游可以劃分成酒店模式、團(tuán)線電商模式、自助游分享模式等來分析成長空間以及市場成熟度；3、主流產(chǎn)品分析，包括有代表性的產(chǎn)品及公司的硬性指標(biāo)、增長態(tài)勢、核心優(yōu)劣勢、各產(chǎn)品間的關(guān)系分析等4、新機(jī)會(huì)分析，包括細(xì)分賽道，比如唯品會(huì)；5、風(fēng)險(xiǎn)分析，包括產(chǎn)品核心價(jià)值的實(shí)現(xiàn)，是否依托于一些技術(shù)突破、上下游公司以及網(wǎng)絡(luò)巨頭是否容易切入這個(gè)領(lǐng)域、是否具有盈利的想象空間。商業(yè)論證文檔：包括關(guān)于成本、效益、選項(xiàng)、問題、風(fēng)險(xiǎn)和潛在問題的信息中得到可行性分析結(jié)果。商業(yè)論證是一種決策支持和規(guī)劃工具以計(jì)劃商業(yè)行為可能的后果，這些后果可能主要從質(zhì)量和數(shù)量緯度考慮。產(chǎn)品邏輯架構(gòu)圖：表達(dá)產(chǎn)品設(shè)計(jì)機(jī)制的一張概念圖，將可視化的具象產(chǎn)品功能，抽象成信息化、模塊化、層次清晰的架構(gòu)，并通過不同分層的交互關(guān)系、功能模塊的組合、數(shù)據(jù)和信息的流轉(zhuǎn)，來傳遞產(chǎn)品的業(yè)務(wù)流程、商業(yè)模式和設(shè)計(jì)思路。產(chǎn)品結(jié)構(gòu)圖（腦圖）：說明功能包含哪些信息，細(xì)化了功能模塊以支持開發(fā)。產(chǎn)品需求分析說明書：是將商業(yè)需求文檔（BRD）和市場需求文檔（MRD）用更加專業(yè)的語言進(jìn)行描述，介紹用戶使用產(chǎn)品的邏輯流程，概括性的描述產(chǎn)品需求、產(chǎn)品版本規(guī)劃、產(chǎn)品整體的框架結(jié)構(gòu)以及功能列表。產(chǎn)品整體流程與產(chǎn)品框架都需要使用相應(yīng)的圖表展現(xiàn)。即是對某個(gè)市場或者是客戶群來講的，類似于調(diào)研報(bào)告，重點(diǎn)是體現(xiàn)出產(chǎn)品要滿足哪些功能，哪些是重點(diǎn)、熱點(diǎn)。產(chǎn)品低/高保真：基本接近產(chǎn)品最終效果圖，也可以是Axure畫出來的原型。UI設(shè)計(jì)稿：產(chǎn)品最終效果圖。產(chǎn)品介紹PPT：方面一：1、產(chǎn)品背景。2、產(chǎn)品簡介。3、產(chǎn)品功能和產(chǎn)品細(xì)節(jié)。4、產(chǎn)品特點(diǎn)和作用。5、產(chǎn)品前景和競爭力；方面二：1、客戶的需求點(diǎn)是什么。2、客戶的痛點(diǎn)是什么。3、放大產(chǎn)品的賣點(diǎn)。4、客觀的提出產(chǎn)品的缺點(diǎn)而不是回避。5、從客戶的角度去解釋產(chǎn)品。6、觀點(diǎn)和想法從客戶角度出發(fā)。7、形式上的創(chuàng)新；方面三：1、介紹公司的基本情況。2、產(chǎn)品研發(fā)的團(tuán)隊(duì)。3、產(chǎn)品的技術(shù)含量。4、產(chǎn)品的特性。5、產(chǎn)品的使用范圍和效果。6、產(chǎn)品的持續(xù)發(fā)展性。7、后期維護(hù)與展望；產(chǎn)品需求規(guī)格說明書：是從業(yè)務(wù)規(guī)則講起的，細(xì)一點(diǎn)偏向于軟件的概要設(shè)計(jì)。是從開發(fā)、測試的角度去講產(chǎn)品功能，里面要包含原型界面、業(yè)務(wù)接口、活動(dòng)圖等。產(chǎn)品驗(yàn)收文檔：列出證明產(chǎn)品驗(yàn)收成果，確保需求符合期望。產(chǎn)品主流程圖：說明產(chǎn)品主流程的操作與運(yùn)行過程。產(chǎn)品核心數(shù)據(jù)流轉(zhuǎn)圖：說明核心數(shù)據(jù)的流轉(zhuǎn)過程，如何形成閉環(huán)的。產(chǎn)品標(biāo)準(zhǔn)功能清單：產(chǎn)品使用的角度來說明產(chǎn)品所擁有的模塊、功能，并對每一個(gè)功能點(diǎn)進(jìn)行描述。產(chǎn)品定制化功能清單：產(chǎn)品使用的角度來說明產(chǎn)品所擁有的模塊、功能，并對每一個(gè)功能點(diǎn)進(jìn)行描述。用戶操作手冊：詳細(xì)描述軟件的功能、性能和用戶界面，使用戶了解到如何使用該的說明書。產(chǎn)品操作培訓(xùn)視頻：詳細(xì)走產(chǎn)品主流程，體現(xiàn)產(chǎn)品價(jià)值核心點(diǎn)，并且講解軟件的功能、用戶界面設(shè)計(jì)與理念，使用戶根據(jù)視頻就可達(dá)到產(chǎn)品在業(yè)務(wù)場景下的使用成果。產(chǎn)品滿意度調(diào)查：客戶認(rèn)為產(chǎn)品已達(dá)到或超過預(yù)期的一種感受，可從多方面進(jìn)行，比如UI設(shè)計(jì)、操作體驗(yàn)等。技術(shù)管理文檔列表軟件需求規(guī)格設(shè)計(jì)說明書：為了協(xié)調(diào)各方（客戶、架構(gòu)師、開發(fā)、測試等）統(tǒng)一目標(biāo)的標(biāo)準(zhǔn)文檔，因?yàn)橐坏╉?xiàng)目比較龐大，跨越多組織多部門時(shí)，這個(gè)文檔可以省去去很多溝通上的眾多麻煩，內(nèi)容包括目標(biāo)、用戶特點(diǎn)、假定和約束、需求規(guī)定、用戶場景、運(yùn)行環(huán)境規(guī)定、驗(yàn)收標(biāo)準(zhǔn)等。系統(tǒng)概要設(shè)計(jì)說明書：系統(tǒng)的基本處理流程、程序系統(tǒng)的組織結(jié)構(gòu)、模塊劃分、功能分配、接口設(shè)計(jì)、運(yùn)行設(shè)計(jì)、安全設(shè)計(jì)、數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)和出錯(cuò)處理設(shè)計(jì)等。系統(tǒng)詳細(xì)設(shè)計(jì)說明書：每一個(gè)軟件系統(tǒng)各個(gè)層次中的每一個(gè)程序（每個(gè)模塊或子程序）的設(shè)計(jì)考慮。系統(tǒng)接口設(shè)計(jì)文檔：接口調(diào)用與簽名、驗(yàn)證說明等。數(shù)據(jù)庫設(shè)計(jì)文檔：數(shù)據(jù)庫設(shè)計(jì)原則說明，數(shù)據(jù)庫表說明，表與功能模塊關(guān)系說明等。系統(tǒng)開發(fā)手冊：按照每個(gè)功能模塊進(jìn)行分類，對每個(gè)功能點(diǎn)的開發(fā)源碼進(jìn)行說明。主機(jī)漏洞安全報(bào)告：項(xiàng)目中使用的組件、框架等漏洞的掃描，如阿里云、騰訊云都有提供此類服務(wù)。基線安全報(bào)告：服務(wù)器容器級別的檢查，如阿里云、騰訊云都有提供此類服務(wù)。代碼掃描報(bào)告：代碼缺陷、代碼漏洞的掃描，如使用Sonar。安全漏洞檢查報(bào)告：運(yùn)用的框架、組件版本與漏洞進(jìn)行掃描，如使用騰訊云鏡。安全白皮書：安全設(shè)計(jì)框架與原則，安全具體細(xì)節(jié)實(shí)現(xiàn)說明，如在對接時(shí)，驗(yàn)證與安全是如何完成，如這個(gè)抽獎(jiǎng)的過程中，用戶的信息安全怎么保護(hù)，網(wǎng)絡(luò)傳輸過程中怎么保護(hù)，前后端對于這個(gè)安全的加密是怎么加解密，用了什么算法？整體系統(tǒng)上安全架構(gòu)這一塊是怎么設(shè)計(jì)的？安全設(shè)計(jì)架構(gòu)圖是怎么樣的？安全框架用了什么框架，在什么地方用到？技術(shù)選型說明文檔：框架/組件選擇及搭配說明，以及技術(shù)安全性描述。數(shù)據(jù)清理文檔：針對測試數(shù)據(jù)清理，避免在交付時(shí)，存在臟數(shù)據(jù)，包括數(shù)據(jù)關(guān)聯(lián)圖，數(shù)據(jù)流向圖，初始化數(shù)據(jù)腳本、清理數(shù)據(jù)腳本，通常先執(zhí)行清理數(shù)據(jù)腳本，在執(zhí)行初始化數(shù)據(jù)腳本，進(jìn)而達(dá)到系統(tǒng)凈化交付。增量更新的測試數(shù)據(jù)，會(huì)根據(jù)數(shù)據(jù)關(guān)聯(lián)圖和數(shù)據(jù)流向圖進(jìn)行清理，比如用戶操作記錄與審批數(shù)據(jù)關(guān)聯(lián)，刪除審批數(shù)據(jù)時(shí)，也要同步刪除用戶操作記錄數(shù)據(jù)。系統(tǒng)源碼：系統(tǒng)全套源碼，一般取決商業(yè)合作模式而視是否提供源碼。源碼結(jié)構(gòu)說明視頻：分層劃分的維度，比如微服務(wù)是按照業(yè)務(wù)模塊維度做劃分的，主流程在源碼的跳轉(zhuǎn)關(guān)鍵邏輯，以及相關(guān)組件參數(shù)配置等。源碼二次開發(fā)說明視頻：基于源碼結(jié)構(gòu)說明視頻講解架構(gòu)設(shè)計(jì)的靈活性，在開發(fā)新需求時(shí)，如何與原有的設(shè)計(jì)模式匹配上，進(jìn)而達(dá)到二開成果。系統(tǒng)架構(gòu)說明視頻：系統(tǒng)的基本處理流程、程序系統(tǒng)的組織結(jié)構(gòu)、模塊劃分、功能分配、接口設(shè)計(jì)、運(yùn)行設(shè)計(jì)、安全設(shè)計(jì)、數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)和出錯(cuò)處理設(shè)計(jì)等。維護(hù)修改建議說明：產(chǎn)品投入運(yùn)行后，發(fā)現(xiàn)了需要進(jìn)行修正、更改等問題，將存在的問題、修改的考慮以及修改的影響估計(jì)作詳細(xì)的描述。測試管理文檔列表可測試需求說明書：測試需求分析階段主要工作是獲得測試項(xiàng)目的測試需求。產(chǎn)品或版本總體測試方案：以測試需求為基礎(chǔ)，制定方案。產(chǎn)品總體測試策略：以測試需求為基礎(chǔ)，分析產(chǎn)品的總體測試策略。自動(dòng)化測試方案：以自動(dòng)化測試需求為基礎(chǔ)，制定方案。測試用例（對客端）：完成各個(gè)特性的測試用例的編寫和自動(dòng)化腳本的編寫。測試用例（內(nèi)部端）：完成各個(gè)特性的測試用例的編寫和自動(dòng)化腳本的編寫。測試計(jì)劃：參考估算未來客戶私有化測試時(shí)間手動(dòng)SIT集成測試報(bào)告：手動(dòng)的測試用例的可度量的執(zhí)行報(bào)告。自動(dòng)SIT集成測試報(bào)告：自動(dòng)化測試用例的可度量的執(zhí)行報(bào)告。手動(dòng)UAT測試報(bào)告：手動(dòng)的測試用例的可度量的執(zhí)行報(bào)告。自動(dòng)UAT測試報(bào)告：自動(dòng)化測試用例的可度量的執(zhí)行報(bào)告。滲透測試報(bào)告：網(wǎng)絡(luò)防御按照預(yù)期計(jì)劃正常運(yùn)行而提供的一種機(jī)制。壓力測試報(bào)告：系統(tǒng)可承載壓力與單個(gè)功能點(diǎn)可承載壓力。測試驗(yàn)收報(bào)告：確保功能測試結(jié)果、邏輯測試結(jié)果都符合需求期望，并且已知BUG已解決。上線業(yè)務(wù)驗(yàn)證方案：明確上線狀態(tài)及驗(yàn)證流程，模板可應(yīng)用將來的增量發(fā)布。測試度量分析報(bào)告：各個(gè)階段的執(zhí)行情況的可度量的數(shù)據(jù)分析報(bào)告。測試關(guān)閉報(bào)告：數(shù)據(jù)和項(xiàng)目總結(jié)報(bào)告。運(yùn)維管理文檔列表資源需求清單：服務(wù)器要求、域名數(shù)量等配置與數(shù)量。網(wǎng)絡(luò)策略說明：需要開通不同安全組之間的網(wǎng)絡(luò)端口，流量流向權(quán)限等。環(huán)境安全策略說明：用戶組權(quán)限、目錄權(quán)限、數(shù)據(jù)庫權(quán)限等說明。系統(tǒng)部署方案設(shè)計(jì)說明書：

系統(tǒng)架構(gòu)、產(chǎn)品架構(gòu)和部署架構(gòu)的說明，以及對網(wǎng)絡(luò)拓?fù)鋱D分層進(jìn)行分析，以及對部署方案和策略的說明。投產(chǎn)上線方案：技術(shù)側(cè)的投產(chǎn)流程，業(yè)務(wù)側(cè)的配合事項(xiàng)進(jìn)行說明，以及對上線步驟進(jìn)行剖析，特別是在有關(guān)聯(lián)系統(tǒng)的情況下，模板可應(yīng)用將來的增量發(fā)布。上線風(fēng)險(xiǎn)評估及應(yīng)急回退方案：

對上線風(fēng)險(xiǎn)進(jìn)行評估，說明可能產(chǎn)生的故障以及觸發(fā)條件，并提出對應(yīng)回退方案，模板可應(yīng)用將來的增量發(fā)布。安裝部署以及啟動(dòng)說明書：

服務(wù)器初始化步驟說明，提供對應(yīng)的安裝包清單，說明基礎(chǔ)軟件安裝部署，以及對應(yīng)服務(wù)安裝部署，并說明驗(yàn)證方式與投產(chǎn)回退。部署安裝包：包括組件安裝包、相關(guān)運(yùn)行與配置腳本的源文件。部署腳本：組件部署腳本說明、應(yīng)用部署腳本說明，常見文件排查等。系統(tǒng)訪問媒介安裝包：系統(tǒng)是通過瀏覽器訪問的，需要提供瀏覽器對應(yīng)版本的安裝包，并且說明版本范圍，比如谷歌xx版本。系統(tǒng)訪問配置文檔：對于系統(tǒng)是否有特殊的配置要求，比如關(guān)閉防火墻等操作。系統(tǒng)運(yùn)維手冊：說明系統(tǒng)結(jié)構(gòu)與網(wǎng)絡(luò)拓?fù)鋱D，對于服務(wù)器信息及域名、數(shù)據(jù)庫、中間件等進(jìn)行說明，業(yè)務(wù)流程的設(shè)計(jì)，應(yīng)用等同樣要進(jìn)行對應(yīng)的說明。運(yùn)維操作手冊：應(yīng)用管理的啟停依賴等說明，并補(bǔ)充對應(yīng)的定時(shí)任務(wù)失敗等情況如何處理，對于服務(wù)器的告警、巡檢等內(nèi)容進(jìn)行補(bǔ)充。應(yīng)急響應(yīng)及恢復(fù)預(yù)案：系統(tǒng)運(yùn)行資源、指標(biāo)、IP和端口，軟硬件等基礎(chǔ)進(jìn)行說明，并說明系統(tǒng)應(yīng)急場景分類、前置條件、處理方式等。雙活及災(zāi)備方案：架構(gòu)說明，應(yīng)用服務(wù)器清單說明，容災(zāi)方案、測試方案說明。一鍵啟動(dòng)腳本說明：服務(wù)啟動(dòng)腳本及執(zhí)行說明。一鍵部署腳本說明：服務(wù)自動(dòng)化部署腳本及執(zhí)行說明。監(jiān)控工具說明書：系統(tǒng)監(jiān)控、應(yīng)用監(jiān)控、定時(shí)任務(wù)監(jiān)控等。運(yùn)行指標(biāo)文檔：系統(tǒng)支撐的指標(biāo)數(shù)據(jù)，比如QPS；對于指標(biāo)分層，比如CPU超過80%是非監(jiān)控狀況，正常的范圍值是多少。項(xiàng)目管理文檔列表項(xiàng)目可行性研究：確定項(xiàng)目是否可行或選擇最佳實(shí)施方案的工作，內(nèi)容包括項(xiàng)目基本情況、項(xiàng)目背景、可能的項(xiàng)目方案、初步評估意見等。項(xiàng)目描述：綜合性地簡要介紹項(xiàng)目的基本情況，包括項(xiàng)目基本情況、項(xiàng)目目的、項(xiàng)目的關(guān)鍵成功要素、項(xiàng)目影響范圍、項(xiàng)目主要里程碑計(jì)劃、項(xiàng)目假設(shè)、項(xiàng)目約束條件、項(xiàng)目評價(jià)標(biāo)準(zhǔn)、項(xiàng)目主要利益相關(guān)方等。項(xiàng)目章程（最好有）：公司內(nèi)部確立執(zhí)行此項(xiàng)目，授權(quán)團(tuán)隊(duì)成員權(quán)利，內(nèi)容包括項(xiàng)目基本情況、項(xiàng)目目的、項(xiàng)目目標(biāo)、項(xiàng)目范圍、項(xiàng)目利益相關(guān)方的角色與責(zé)任、有關(guān)項(xiàng)目的權(quán)限、管理檢查點(diǎn)、相關(guān)方簽字等。團(tuán)隊(duì)章程（必須有）：章程說明與管理規(guī)范，包括目標(biāo)、成功標(biāo)準(zhǔn)、退出標(biāo)準(zhǔn)、內(nèi)/外部相關(guān)方、成員分工與職責(zé)、基本溝通流程、需求溝通流程、對內(nèi)/對外溝通矩陣、微信群管理制度、會(huì)議管理制度、需求確認(rèn)流程、技術(shù)確認(rèn)流程、升級流程、沖突/風(fēng)險(xiǎn)/問題處理流程等。項(xiàng)目范圍管理：相當(dāng)于SOW，對項(xiàng)目所要完成的工作范圍進(jìn)行綜合描述，包括項(xiàng)目基本情況、項(xiàng)目成果/完成標(biāo)準(zhǔn)、使用的方法、項(xiàng)目包含內(nèi)容、項(xiàng)目不包含的內(nèi)容、相關(guān)方確認(rèn)簽字等（客戶簽字是很重要，影響驗(yàn)收）。項(xiàng)目風(fēng)險(xiǎn)管理計(jì)劃：如何在應(yīng)對風(fēng)險(xiǎn)與措施，比如風(fēng)險(xiǎn)升級流程，內(nèi)容包括項(xiàng)目基本情況、風(fēng)險(xiǎn)管理策略、風(fēng)險(xiǎn)分類、風(fēng)險(xiǎn)分析、風(fēng)險(xiǎn)處置、風(fēng)險(xiǎn)處置后分析等。風(fēng)險(xiǎn)登記冊：風(fēng)險(xiǎn)描述、優(yōu)先級、責(zé)任人、跟進(jìn)人、狀態(tài)、影響范圍、應(yīng)對措施等。問題登記冊：問題描述、優(yōu)先級、責(zé)任人、跟進(jìn)人、狀態(tài)、影響范圍、處理措施等。待辦事項(xiàng)列表：待辦事項(xiàng)描述、跟進(jìn)人、執(zhí)行人、處理措施、狀態(tài)、要求完成日期等。項(xiàng)目配置管理計(jì)劃：人事物配置策略，內(nèi)容包括項(xiàng)目基本情況、配置管理職能領(lǐng)域及資源、標(biāo)準(zhǔn)、流程、政策及方針、配置識別、識別方法、控制項(xiàng)的提交與檢索、版本控制、項(xiàng)目使用媒體的保存處理及交付、與承包商配置管理的關(guān)系、其他信息等。項(xiàng)目采購管理計(jì)劃：制定出能夠最好地滿足項(xiàng)目需求的采購工作計(jì)劃安排的管理流程，內(nèi)容包括項(xiàng)目基本情況、采購定義、合同責(zé)任、決策標(biāo)準(zhǔn)、采購合同類型、合同標(biāo)準(zhǔn)等。項(xiàng)目資源管理計(jì)劃：可以看作戰(zhàn)場上的排兵布陣，就是確定、分配項(xiàng)目中的角色、職責(zé)和回報(bào)關(guān)系，內(nèi)容包括項(xiàng)目基本情況、資源概要、項(xiàng)目資源信息、人力資源計(jì)劃等。資源清單：物品資源列表、人員資源列表等。項(xiàng)目預(yù)算：將真正的成本顯示出來，便于成本控制，有利于對各項(xiàng)目活動(dòng)成果進(jìn)行評價(jià)、考核，內(nèi)容包括項(xiàng)目基本情況、預(yù)算分類等。項(xiàng)目質(zhì)量管理計(jì)劃：如何確保質(zhì)量成果產(chǎn)出的過程，內(nèi)容包括項(xiàng)目基本情況、項(xiàng)目工作范圍、可交付成果描述、可交付成果的驗(yàn)收標(biāo)準(zhǔn)、質(zhì)量保證的各種活動(dòng)、項(xiàng)目監(jiān)控、項(xiàng)目質(zhì)量小組責(zé)任等。項(xiàng)目溝通管理：與客戶如何溝通，升級流程如何等，內(nèi)容包括項(xiàng)目基本情況、溝通時(shí)間、信息類型、現(xiàn)行溝通系統(tǒng)、需要信息的時(shí)間長度、考慮的環(huán)境因素、更新溝通計(jì)劃的方法等。相關(guān)方登記冊：內(nèi)部團(tuán)隊(duì)成員姓名、手機(jī)號碼、職位、經(jīng)驗(yàn)等；外部相關(guān)方，姓名、權(quán)利、職位、影響等。項(xiàng)目會(huì)議紀(jì)要：包括基本信息、會(huì)議目的、參加人員、發(fā)放材料、發(fā)言記錄、會(huì)議決議、會(huì)議紀(jì)要發(fā)放范圍等。項(xiàng)目變更控制計(jì)劃：對項(xiàng)目的變更進(jìn)行有效的控制，從而更好地實(shí)現(xiàn)項(xiàng)目的目標(biāo)，內(nèi)容包括項(xiàng)目基本情況、請求變更信息、對變更請求的初步審查結(jié)果、初步的影響分析、影響分析結(jié)果、變更審查人員簽字等。需求開發(fā)計(jì)劃：消除或減少不確定性，對項(xiàng)目目標(biāo)有更好的理解，內(nèi)容包括需求、涉及方（A團(tuán)隊(duì)/B團(tuán)隊(duì)）、需求負(fù)責(zé)人、需求狀態(tài)（評審/