-1

我是Rails開發人員的紅寶石。對於我的項目,我正在寫一個API調用。 Angularjs將使用此API在網頁上顯示數據。軟件設計規範(SDS)文檔中包含什麼

我在編碼很好,但是這是我第一次將創建SDS文件..我不知道我的SDS文件lnclude ...

我對SDS在互聯網上搜索,發現了很多lotnof文章,但其中很多是非常高層次難以理解的文件。

我應該在我的SDS文檔中寫什麼因爲我的rails代碼都是關於API調用的...... ?? Plase共享樣本文檔,如果可能的...

感謝

回答

1

你至少應該包括在你的SDS一些基本的解釋,即使代碼很簡單,你說的。

目的,範圍,使用的模式(如果有),數據庫細節,是本文檔應具有的基本部分。序列圖不會受到太大影響,它們對於解釋實際過程和流程很有幫助

+0

感謝您的解釋。 –