設計文檔內容 - 需要什麼？

Question

在編寫低級設計文檔時，必須擁有什麼並且很好。對高級文檔也重複相同的問題。

Answer 1

假設您正在爲某人創建設計文檔或爲某些目的服務。它需要包含的內容只能由該人或目的決定，當然沒有一般的答案。

如果有人要求你寫一份設計文件，你應該問他們他們需要什麼。

如果您的開發流程規定了設計文檔，它也應該指定它包含的內容。

就我個人而言，我同意Jack Reeves的概念the code is the design，我不想寫一個單獨的設計文檔。

如果我需要清楚地思考一個設計，我當然會在白板或紙上繪製一些UML圖表和/或筆記，但是如果我能夠擺脫它，我寧願不保留它們。