編寫詳細設計文檔的最佳做法是什麼？

Question

請提供有關撰寫設計文檔的最佳實踐的材料。

Answer 1

我也不得不推薦那本書Donut suggested in his last sentence，Software Requirements (2nd Edition)，也是該書的同伴 - More About Software Requirements。這兩本書都是由Karl Wiegers編寫的，his website也有一些有趣的閱讀，尤其是Goodies section，它有免費的示例文檔和模板。

Answer 2

This article關於寫作質量要求可能值得一讀。文章的結尾有一些通用的「準則」，可能對您有用。

其中準則之類的東西：

• 保持句子和段落簡短
• 使用主動語態
• 找到粒度適當水平（書面應單獨可測試的需求）
• 避免在一個陳述中寫出多個要求（連詞如「and」和「or」可以幫助你發現這一點）

Lots的othergoodresources類似於上面的文章可以幫助給你一些觀點。如果您正在尋求更全面的要求「最佳實踐」，請查看第二版軟件要求（Amazon）。

Answer 3

只是一些基本的想法：

• 知道你寫的觀衆，並根據需要調整（請記住，你需要獲得跨有效的消息/信息）
• 自上而下，使設計成爲一個可以理解的故事
• 只根據需要提供了儘可能多的細節 - 總會有關於規格的問題，不要過度使用它並可以隨時更改
• 保留規範中的版本和更改日誌部分，瞭解最新情況和變化ED
• 採取書面形式