Как написать спецификацию уровня обслуживания?

Question

В настоящее время я создаю сторонний прототип для веб-приложения, и вскоре программисты на бэкэнде начнут создавать сервисный уровень. Они попросили меня написать простую спецификацию форматов данных, которые я хочу получить от различных служб, а также возможные параметры и т. Д.

Есть ли стандартный способ написания или структурирования таких спецификаций? Может ли кто-нибудь привести пример?

PS: Все запросы на обслуживание будут выполняться в Javascript асинхронно.

Answer 1

Напишите SDD вместе с бэкэнд-командой.

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

• Определить данные. Независимо от того, какие данные обрабатываются вашим приложением (клиент и сервер).

• Определить архитектуру. Как вы уже упоминали, вы делаете HTTP-запросы от клиента к серверу с помощью asynchronic Javascript.

• Определите интерфейсы. Как только у вас есть общее понимание данных и архитектуры, интерфейсы намного проще собрать. В описаниях интерфейсов обычно описываются все функции (с кратким описанием, параметрами и возвращаемыми значениями). Если вам нужен пример описания интерфейса RESTful, посмотрите на документ enStratus.

Используйте множество фотографий и примеров, чтобы сделать документ читаемым. Не делайте это слишком долго: K.I.S.S!