如何寫作品的介紹文檔

介紹文檔有什麼用?

讓看你作品的人通過這個文檔更好地瞭解你的作品!

以自己的一次參賽經驗來分析(微信小程序應用開發大賽),總結主要是以下幾個步驟:

1. 產品定位

(1)應該說清楚這是一個什麼小程序,具體的應用場景是什麼以及解決什麼實際問題?建議直接了當,突出重點,應用場景和實際問題要有一定的調查材料支撐,注意不能是網上隨便抄來的。這部分是讓評委大概瞭解這個小程序是幹什麼用的以及爲什麼要開發。
(2)提出現實問題之後,建議簡單地闡述一下自己的產品方案,這裏的方案不是技術方案,而是自己打算做一個什麼樣的產品來解決現實的問題。

2.需求分析

雖然參賽的介紹文檔中沒有明確說明要做需求分析,但是產品定位的評分中要求有明確的目標用戶和使用場景,所以比較好的做法是進行用戶和需求分析。

(1)在用戶和需求分析方面,大家可以採用自己學過的一些方法和技術,原則就是用戶分析到位, 系統需求應該包括功能需求和非功能需求,不論是哪方面的需求,都應該是緊密結合自己要開發的系統,而不是泛泛地抄一些類似教科書上面的內容。
(2)舉例:參觀清華的非功能需求就是根據系統的實際要求,提出了關鍵的三個內容:一是性能, 給出具體的量化指標;二是安全性,諸如身份證敏感信息等;三是可靠性,包括停電和斷網問題、遊客快速進入的問題等。

3.交互設計

交互設計部分應展現整個系統的信息結構,說明配色和整體設計原則,把系統核心功能的交互設計圖展現出來,然後選擇自己認爲可以突出亮點的幾個關鍵設計進行說明。

4.技術方案

技術方案部分應給出系統的總體框架設計圖,並做相應的說明,然後給出系統的技術選型、開發環境,包括所採用的框架、第三方組件等。總體框架介紹清楚之後,應該着重介紹系統開發方面自己的突出貢獻部分或者亮點部分,這個需要根據自己開發的系統進行歸納,選擇核心重點或技術難點部分來說明相應的技術實現。

5.系統測試

這個部分是可選的,爲了說明自己系統的最終效果,可以考慮寫一下功能測試和性能測試,說明測試方案和測試結果,要注意清楚而且有實際的真實測試結果,不要亂寫亂編。
如果自己開發的系統非常簡單,而且沒有特別的性能要求,可以忽略這部分。

6.系統上線與運維

對於一些需要自己運營的作品,這部分也是非常重要的,需要說明如何上線以及未來的運營和維護方案,特別是一些需要特殊資質的作品,更要說清楚這一點。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章