微服務架構下文檔管理規范


  如果使用微服務架構進行應用開發,微服務的開發過程中,會產生許許多多的文檔,其中包括需求文檔、設計文檔、開發文檔、測試文檔、運維文檔以及各種項目管控文檔。而且微服務的開發,一般都會引入敏捷的開發模式,雖然敏捷倡導“個體和互動高於流程和工具,工作的軟件高於詳盡的文檔”,但並不是說文檔資料不重要,而是精簡規范文檔高於繁復套路文檔,精簡規范實用性較強的文檔,是提高企業或團隊整體交付及創新能力的基礎。

  因此,文檔資產的管理在軟件的研發過程中,是非常重要的,那么如何對文檔進行更高效的管理,一般需要從以下幾個方面進行規范化管控:目錄結構、文檔命名、文檔格式。

1.目錄結構規范

  對於有大量文檔的項目,文檔分類的目錄結構有着舉足輕重的作用,好的文檔目錄結構是能夠起到自說明的作用(類似於開發中,好的程序包名是能夠進行自說明業務模塊),因此,目錄結構的規范,建議按照項目、階段、模塊等進行划分。建議參考如下文檔目錄結構規范:

├─XXX項目A

│  ├─01.項目准備

│  ├─02.需求分析

│  │  ├─01.用戶故事

│  │  └─02.故事清單

│  ├─03.需求設計

│  │  ├─01.總體設計

│  │  ├─02.概要設計

│  │  ├─03.詳細設計

│  │  ├─04.原型設計

│  ├─04.需求開發

│  ├─05.需求測試

│  │  ├─01.單元測試

│  │  ├─02.集成測試

│  │  ├─03.功能測試

│  │  └─04.性能測試

│  ├─06.項目上線

│  │  ├─01.上線准備

│  │  └─02.上線培訓

│  ├─07.項目運維

│  │  ├─01.環境信息

│  │  ├─02.操作手冊

│  │  ├─03.運維手冊

│  │  └─04.應急手冊

│  ├─08.實踐經驗

│  │  ├─01.經驗總結

│  │  └─02.最佳實踐

│  └─09.項目管理

│      ├─01.項目計划

│      ├─02.項目周報

│      └─03.會議紀要

└─XXX項目B

   ├─01.項目准備

   ├─02.需求分析

2.文檔命名規范

  對文檔管理的目錄進行規范化之后,需要對文檔的命名進行規范化,文檔的命名一般建議采用三階段命名:

  建議命名規范:{公司簡稱}_{系統|產品全稱}_{文檔核心用途}.{文檔后綴}

  例如:普元金融_DevOps平台_用戶操作手冊.pdf

  第一階段:說明文檔的歸屬,一般建議為公司的簡稱,例如:普元金融、阿里巴巴等。

  第二階段:說明文檔的所屬產品或項目,一般建議以項目的全稱,例如:個人網銀系統、企業服務總線系統等。

  第三階段:說明文檔的核心名稱,例如:用戶操作手冊、服務管理規范等。

  第四階段:一般為文件的版本信息,可省略(由於目前大多數的文檔庫管理軟件,均已實現多版本管理,已無需在文檔的命名上添加版本信息,例如:gitlab等)。

3.文檔格式規范

  作為一個閱讀者而言,一個文檔是否能夠閱讀下去,首先應該是文檔的格式,其次才是文檔的內容,因此對於文檔的內容,那是專業層次的內容,在規范層面不進行闡述,本文只針對文檔的格式進行規范化。

  文檔格式的規范化,應該從首頁、目錄、版本信息、閱讀對象、頁眉頁腳、以及字體等進行規范化:

  首頁:文檔的首頁可以有封面,也可以沒有封面,首頁主要闡述文檔的基本信息,如:文檔名稱、文檔作者、編寫時間、保密級別等信息;

  目錄:文檔的目錄起到索引的作用,建議文檔的目錄到文檔的三級菜單,並且超鏈接頁碼;

  版本信息:文檔的修訂記錄,何時、何人修改了何內容,版本建議三位數組成,建議版本規范:V1.0.0,第一位:代表主版本,第二位代表審批版本,第三位代表修改版;

  頁眉頁腳:頁眉主要用於說明文檔的章節或文檔的密級,頁腳主要用於描述文檔的頁碼及版權信息;

  閱讀對象:本文檔的面向用戶,在面向用戶部分,需要簡單說明面向用戶需要儲備的知識;

  字體規范:正式的文檔,一般建議采用宋體、仿宋或微軟雅黑中的一種,整個文檔建議采用同一種字體,並且字體的正文建議采用小四;

  段落行距:段落需要縮進2個字符,行間距建議為1.5倍;

  其他的一些規范,建議以實用為主,但不能大白話。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM