包含在软件设计规范(SDS)文档

时间:2016-11-29 19:02:07

标签: ruby-on-rails-4 documentation specifications software-design

我是rails开发人员的红宝石。对于我的项目,我正在编写API调用。 Angularjs将使用此API在网页上显示数据。

我擅长编码,但这是我第一次创建SDS文档..我不知道在我的SDS文档中包含什么...

我在互联网上搜索sds并在其上发现了许多文章,但其中很多都是非常难以理解的文档。

我应该在我的SDS文档中写什么因为我的rails代码都是关于API调用的?如果可能,Plase分享样本文件......

由于

1 个答案:

答案 0 :(得分:1)

你应该在SDS中至少包含一些基本的解释,即使代码很简单,如你所说。

目的,范围,使用的模式(如果有),数据库细节,是本文档应具备的基本部分。序列图也不会受到伤害,它们非常适合解释实际流程和流程