程序可視化

Question

我從一個web項目開始，我想將它的功能和功能寫在專業人士的「紙上」。我必須與有關

• 目的和項目概況的所有信息準備項目的文檔，
• 數據庫結構，
• MVC和REST功能（模型，視圖，控制器），
• 網站和小部件的佈局和功能，
• 客戶端/服務器通信。

我想準備的是一個項目的建議，我解釋了這個想法和確切的解決方案，以及如何實施所有細節。

我該如何準備？我需要什麼？你能告訴我一個例子嗎？

Answer 1

專業人員專注於觀衆。這個文件的目的是什麼，它需要講述的故事？寫作需要時間，而且必須與其他花費時間的方式平衡。

您是否需要將該項目出售給客戶？還是管理？投資者？還是給你的合作開發者？或者它主要是爲了你自己？

細節的水平會有很大的不同。演示文稿的形式和演示順序也會有很大的不同。

是否足以只是做的白板討論或牛皮紙會議幾張快照，或者你需要一個光滑的小冊子，視頻和PowerPoint？

對於您可能希望把它所有的維基中的Web項目。

如果您有兩種不同的公開，您可能需要創建單獨的文檔或至少提供管理摘要。把重點放在管理總結的業務上，把好的技術優勢放在你的合作開發者閱讀的部分。

Answer 2

與實施不同的要求。我會得到一個初始文檔，以捕獲系統的「什麼」。

文檔的網站 - 我使用該狀態圖。每個頁面都是一個狀態，每個可能的導航/操作都是一個轉換。根據您的確切用戶，您可能需要模擬屏幕，以便了解轉換。

頁和模板的詳細設計是有點二次 - 我喜歡把這個回監守它往往是，每個人都希望成爲一個設計師的作品。

如果系統的接口還包括外部調用Web服務（或許REST），然後記錄它的外部接口的一部分，並需要使用它的人的同意。簡單的UML類圖或僞代碼接口。

將有與這些僞影相關聯的「接口數據模型」。數據顯示在plages上並由任何公共nservices返回。這可以在您選擇的數據建模工具中進行建模（我將使用UML類圖）。

設計中的...MVC層和詳細的業務邏輯可以使用面向對象技術建模，UML也可以正常工作。

Peristence layer ...取決於數據庫/遺留系統是否已經存在。您需要某種數據模型，並且可能需要記錄接口數據和Peristed Data之間的映射 - 這可能很簡單，也可能需要非常詳細的設計。捕獲映射數據最好在表格或類似電子表格的工具中完成。

Answer 3

我勸你寫了兩份文件：

• 一個技術說明：如果在需要時您會寫所有的技術性的東西，從數據庫結構的協議描述。

• 一個功能描述：從哪裏編寫所有功能的東西，從項目的目的到應用程序的每個功能的描述。

每個文檔都會針對不同的人，其中一些非常擅長技術細節，另一些非常擅長應用程序的可用性。

當我想確定我的技術和功能文檔是有用的時候，我會寫下他們的想法：「如果我明天去世，我希望閱讀這些文檔的人以各種方式理解應用程序，並且我希望他們確保如何做到這一點，就像我希望這樣做「。我最終最終深入瞭解應用程序的細節，但通常是一個好主意。我注意到我寫這些文檔的時間越多，後來獲得的電話就越少，而且一旦應用程序進入測試階段，我就會得到越少的驚喜。

Cliffnotes：兩個文檔針對兩個截然不同的觀衆。一位技術人員對技術花絮非常感興趣，另一位對技術花絮毫不瞭解。花點時間，解釋一些事情，製作模式和圖表（如果你確定自己擅長這些），一次又一次地閱讀你的文檔，你就會有一個可靠的文檔。

編輯：Word（或任何其他文字處理程序）通常足夠製作這種文檔。使用UML並不總是一個好主意，尤其是如果你不擅長UML（不要羞愧:)。

我發現一個小技巧很有用：使用所見即所得的網頁編輯器可以幫助您製作快速且簡潔的頁面原型，您可以將其插入到文檔中。我甚至在重新安裝舊計算機上安裝VB6的過程中，爲此製作了一個快速而又髒的窗口應用程序原型。它效果很好，所需時間很少。