讀古今文學網 > 程序員必讀之軟件架構 > 保持短小簡潔 >

保持短小簡潔

探索十分有趣,但始終要花時間,而我們往往沒有時間。既然代碼不會講述完整的故事,一些輔助文檔就非常有用,特別是如果你把軟件交接給其他人或者經常有人離開和加入的團隊。我的建議是,把這個輔助文檔當作一個指南,它應該給人們上手提供足夠的信息,幫助他們加快探索的過程。不過要抵擋住深入太多技術細節的誘惑,因為理解那個層次細節的技術人員自然知道如何從代碼庫找到它。和任何事一樣,其中有一個愉快的平衡點。

以下標題描述了你可能想要包含在軟件指南中的事情:

1.語境;

2.功能性概覽;

3.質量屬性;

4.約束;

5.原則;

6.軟件架構;

7.外部接口;

8.代碼;

9.數據;

10.基礎設施架構;

11.部署;

12.運營和支持;

13.決策日誌。