一、軟件功能設(shè)計(jì)文檔

1、標(biāo)題和人員

設(shè)計(jì)文檔的標(biāo)題，作者（項(xiàng)目的參與者），文檔的審閱者，以及文檔最后更新的日期。

2、概述

可以被公司里任何一個(gè)工程師所理解并且根據(jù)概要內(nèi)容決定是否需要閱讀文檔的其余部分。這部分非常多不超過3個(gè)章節(jié)。

3、背景

對(duì)于問題的描述、為什么要做這個(gè)項(xiàng)目、評(píng)估項(xiàng)目需要了解哪些內(nèi)容以及如何融入到技術(shù)戰(zhàn)略，產(chǎn)品戰(zhàn)略或者是團(tuán)隊(duì)的季度目標(biāo)中。

4、目標(biāo)和非目標(biāo)

目標(biāo)應(yīng)該包括

明確描述哪些問題不在目標(biāo)范圍內(nèi)也同樣重要。確保所有人對(duì)于目標(biāo)的理解是一致的。

5、里程碑

一些可衡量的檢核點(diǎn)。你的PM以及你的經(jīng)理的經(jīng)理通過瀏覽就可以了解項(xiàng)目各個(gè)部分的推進(jìn)情況。如果項(xiàng)目超過1個(gè)月，我建議你把項(xiàng)目拆分成多個(gè)面向用戶的里程碑。

使用自然日以便考慮延遲、假期和會(huì)議等等。它看起來可能是下面這個(gè)樣子：

開始時(shí)間：2018年6月7日

里程碑1 – 新系統(tǒng)MVP可在夜間模式下運(yùn)行：2018年6月28日

里程碑2 – 下線舊系統(tǒng)：2018年7月4日

結(jié)束日期：新系統(tǒng)增加功能X，Y，Z：2018年7月14日

如果其中一些里程碑的預(yù)計(jì)結(jié)束時(shí)間（ETA）發(fā)生變化，可在后面增加[更新]部分。這樣項(xiàng)目干系人可以很容易了解到最新的計(jì)劃。

6、現(xiàn)狀

除了描述當(dāng)前的系統(tǒng)實(shí)現(xiàn)以外，您還應(yīng)該通過概要的流程圖來描述用戶是如何和系統(tǒng)交互以及數(shù)據(jù)是怎么流轉(zhuǎn)的。用戶故事是完成此類工作的很好的方式。但別忘了你的系統(tǒng)會(huì)有很多類型的用戶，每種用戶都有不同的用戶用例。

7、建議方案

這是有些人稱之為技術(shù)架構(gòu)的部分。首先提供一個(gè)大的方向，然后填充大量的細(xì)節(jié)。嘗試通過用戶故事來進(jìn)行細(xì)化。這部分可以包含很多內(nèi)容和圖表。想象你寫完這部分就跑到一個(gè)荒島上去度假了。團(tuán)隊(duì)里其他工程師可以輕松的通過這部分來實(shí)現(xiàn)這個(gè)方案。

延伸閱讀：

二、WIKI是什么

Wiki是一種在網(wǎng)絡(luò)上開放且可供多人協(xié)同創(chuàng)作的超文本，支持面向社群的協(xié)作式寫作，Wiki站點(diǎn)可以有多人（甚至任何訪問者）維護(hù)，每個(gè)人都可以發(fā)表自己的意見，或者對(duì)共同的主題進(jìn)行擴(kuò)展與探討。

其內(nèi)容具有極高的關(guān)聯(lián)性，初始架構(gòu)不好的話可能會(huì)造成內(nèi)容結(jié)構(gòu)零散，不好閱讀；Wiki 語(yǔ)法標(biāo)準(zhǔn)不一樣，不同的wiki系統(tǒng)采用的語(yǔ)法不一致，造成作者編輯困難；并且結(jié)構(gòu)和頁(yè)面展示形式較難調(diào)整。使用wiki的時(shí)候需要遵循一定的準(zhǔn)則，精心的編寫維護(hù)。