Что включить в документ спецификации программного обеспечения (SDS)

Question

Я разработчик рубинов на рельсах. Для моего проекта я пишу вызовы API. Angularjs будет использовать этот API для отображения данных на веб-странице.

Я хорошо в кодировании, но это в первый раз я буду создавать SDS документ .. я не знаю, что lnclude в моем ДСН документе ...

У меня есть поиск в интернете о ДДС и нашел много статей на нем, но многие из них были очень высокого уровня, трудно понять документ.

что я должен написать в своем документе SDS Как мой код rails - это все об API-вызове ... ?? Plase разделяет образец документ, если это возможно ...

Благодаря

Answer 1

вы должны включать по крайней мере некоторые основные объяснения в вашем SDS, даже если код прост, как вы говорите.

Назначение, область применения, используемые шаблоны (если есть), спецификация базы данных, являются основными разделами, которые должен иметь этот документ. Схемы последовательности также не повредят, они отлично подходят для объяснения фактических процессов и потока.