技術設計文檔的工具和標準

Question

我想知道我的同事現在使用哪些工具和標準來製作技術設計文檔。

在過去，當我在我們公司時，我們只提供客戶端服務器贏取應用程序，我們爲我們的設計文檔提供了單詞模板。我們的模板總是從數據庫圖表開始，然後是UI模型，字段映射，功能描述等等。對於Word和Visio，我們已經有足夠的了。但最近我們正在將Wiki，UML圖表，原型工具等結合起來......對標準和工具沒有真正強有力的政策。你認爲給予架構師自由選擇他們認爲在每個項目的特定時刻適合的工具和標準是否有益，或者公司是否應該強制執行這些工具和標準？

Answer 1

任何設計文檔背後的原因都是與所有相關人員之間的明確溝通。因此，從這個角度來看，無論您作爲架構師選擇哪種工具，都需要現在由所有參與者讀取完成的產品，然後由維護人員讀取。因此，選擇至少一些相當標準的工具是有道理的，這些工具在未來幾年仍將存在。

也就是說，設計文件通常用於使項目或系統啓動和運行。此後有足夠的文檔記錄代碼和一些基本文檔應該足夠了。我可能會更多地關注文檔的組織結構，以便人們可以很容易地找到他們未來尋找的內容。它可以幫助執行某種標準的存儲庫結構/系統來存儲文檔，但不一定要堅持各種各樣的文檔模板。關注內容而不是工具。

Answer 2

除非您的項目是千篇一律的，否則只有將最佳工具組合應用於手頭工作纔有意義。也就是說，可能需要一些寬鬆的（粗略的指導方針）或狹義的（適用於特定的環境）標準。

Answer 3

在我看來，首席開發人員或團隊成員（可能記錄在後面）之間的深入討論比任何文檔都更有價值。給他們所有的選擇工具的自由，並要求他們在早期寫出高層技術決策的簡短摘要。這可以成爲項目後續文檔的基礎。技術設計文件過早過早，需要花費太多時間來編寫。

Answer 4

我認爲應該有一套工具和標準在體系結構時指定，描述應該如何記錄設計。有一個記錄這些事情的標準是非常重要的;否則，他們傾向於站不住腳;如果設計文檔是異構的，那麼真正需要了解設計最多的人可能無法在真正需要設計信息時找到他們真正需要的設計信息。

也就是說，工具和標準的選擇完全取決於每個不同的組織;無論一個組織的作品是否適合他們。只要標準（以及某種程度上的工具）保持一致，爲個別組織選擇的任何內容都適合他們。它只是需要決定並執行。