編寫開發文件的基本流程

2021-09-12 03:41:09 字數 1889 閱讀 8431

專案開發過程中為了增加程式的可讀性和程式的健壯性, 方便後期程式的除錯和維護,所以需要在開發過程中統一技術規範,一般會在專案初期確定好相關文件作為這一統一的規範。不同公司會對文件做不同要求,劃不同的分類,但一般來說(或者拿自己的經驗說)大致可以分為需求文件、介面文件、流程圖(可以單獨作為乙份檔案可以作為附件附在文件中)、變更檔案等。

一、需求文件

在專案啟動之後,專案的目標已經明確了,那麼就要開始著手幹活了,但是在幹活之前,需要對整個專案分析透徹。那麼,如何對業務進行分析呢,看以下的建議。

首先,開發人員要有隨意轉換身份的意識和能力。

a、明確產品功能

在分析業務時,站在使用者的角度上,思考要做的產品能實現什麼功能。把所有的功能點列出來!

b、分析某一功能點的流程

在羅列了所有的功能之後,需要站在開發者的角度分析每乙個功能點,考慮從客戶端到後台運算元據庫的整個流程,可以從是什麼、為什麼、在哪、怎麼做、誰來做、做完如何反饋、反饋給誰、上傳到哪、伺服器用什麼資料庫、資料庫需要什麼表、表裡有什麼字段、每個欄位的屬性及意義等等。比如,我要要做乙個軟體中個人頭像上傳的功能,首先明確我做的是上傳功能;為什麼要上傳?因為個人資料需要頭像;怎麼做上傳?通過網路i/o實現;這個功能在什麼位置?軟體有個個人中心模組,個人中心裡有個個人資訊子模組,在這個模組裡可以上傳頭像;誰上傳?已經登入的使用者;上傳完之後如何反饋?彈窗提示上傳成功;反饋給誰?客戶端已登入的使用者;上傳到哪?伺服器上;用什麼資料庫?mysql;需要什麼表?(存到)使用者表;表裡有什麼字段?使用者資訊的基本字段;每個欄位的屬性及意義?略。在思考完這些問題之後,可以把乙個功能點串成一條完整的從前端到資料庫的線。

c、整合各個功能點--明確分工

在串完所有的功能點之後,站在乙個高一層次的角度,把每個功能點之間的聯絡理清楚,按照相互的聯絡分工合作,優化其中的細節問題。

d、撰寫需求文件

分工完成之後,按照第二步分析的內容,每個人把自己負責的功能整理成文件,最後合併文件,作為統一的需求文件。

e、繪製業務流程圖

需求文件確定之後,繪製整個專案的業務流程圖,這時候的流程圖只需要包含前端的業務流程,後台實現的流程圖不需要在需求文件中體現,而是放在後面的介面文件中。

二、介面文件

不同公司對介面文件的要求也不盡相同,但包括的內容卻是大同小異的。封面、標題、審批頁、修訂歷史以及格式字型等等風格迥異的次要內容不做贅述,只講乾貨!乾貨!乾貨!

a、請求位址

需要哪個線上位址就寫哪個。注意不要反低階錯誤,比如寫錯某個字母或者大小寫問題。

b、介面資訊

說明請求方式,是post還是get。

c、功能描述

清晰地描述介面功能,要求言簡意賅,不要寫太多廢話,也不要遺漏任何細節。

d、介面引數說明

宣告引數的名稱,嚴格要求與呼叫一致,包括大小寫;

簡單說明引數的含義;

備註部分,說明引數值是需要哪個公司提供,並詳細說明引數怎麼生成的,例如時間戳,是哪個時間段的;引數是否必填,一些引數是必須要有的,有些是可選引數,一定要注意寫清晰。

e、返回值說明

有乙個模板返回值,並說明每個返回引數的意義。提供乙個真實的呼叫介面,真實的返回值。

f、介面呼叫限制

為了安全,雙方採用乙個一致的加密演算法,保證介面呼叫的安全。

g、文件維護

文件維護時,修改內容部分需要有修改人、修改日期、版本號的資訊。

三、流程圖

流程圖可以單獨作為乙份檔案,也可以作為附件附在對應的文件中,具體執行按要求來。

業務流程圖

程式結構圖

程式流程圖

四、變更檔案

在開發過程中如果出現與預期計畫、文件不一致的地方,則視為發生變更,此時大致需要提供以下資訊:

a、版本歷史(版本號、基本資訊)

b、變更前現狀

c、變更內容

d、影響評估

e、審批

專案開發文件編寫規範

在開發專案的過程中,我深刻的意識到,文件存在的意義並不是無用的報告,簡潔明瞭的文件不光能記錄你當下所做的,還能在繁重的工作中分神思考下一步該做什麼時為你節約精力,並且在專案週期內,使整個專案保持一致性。所以,軟體開發文件的編寫是很有必要的。我參考網上的資料,結合自己專案開發時的心得,分享一些經驗。在...

軟體開發文件如何編寫

目 錄 1.概述4 1.1編寫目的4 1.2定義4 1.3關鍵字5 1.4參考資料5 2總體設計5 2.1需求規定5 2.2執行環境5 2.3 基本設計概念和處理流程 2.4 結構 2.5 功能需求與程式的關係 2.6 人工處理 2.7 遺留問題 3介面設計5 3.1使用者介面6 3.2外部介面6 ...

軟體開發文件編寫規範

對於軟體工程學科的同學都知道,軟體工程是一門技術含量高設計極其複雜的學科。為了控制好軟體產品質量和規範,就必須用大量的文件約束軟體工程的進度和狀態。浩大的軟體工程對於缺少工作和專案經驗的人來說,必然是摸不著頭腦不知從何開始。為了讓大家能夠快速適應標準的軟體開發過程,今天我為大家粗略的描述開發中需要的...