capraldavid / specification-template

Project Spec template

<PROJECT> — специфікація

1. Контекст

• Хто і з якою метою пише цей проект?
• Чи планується розгортання проекту? Якщо так, то в якому середовищі?
• Які технології плануєте обрати для реалізації проекту?

Наприклад:

Проект реалізовується фундацією Wayne Enterprises та Лігою Справедливості. Метою проекту є глобальний спостережний центр та опорний пункт, з якого учасники Ліги Справедливості можуть оперативно реагувати на інциденти на планеті Земля. Проект будемо реалзовувати у якості космічної станції на ядерному паливі на низькій орбіті Землі.

Команда:

• Брюс Вейн — фінансування
• Флеш — працює генератором енергії
• Супермен — тягає важкі предмети

2. Задачі

• Які задачі вирішує проект?
• Які задачі поза скоупом даного проекту?
• Якщо є вимоги до відмовостійкості, абощо — теж вказати.

Наприклад:

В рамках проекту будуть вирішені такі задачі:

• Спостереження за катаклізмами на планеті Земля
• Своєчасне повідомлення найближчих членів Ліги Справедливості про необхідніть втручання
• ...

Оскільки технологія телепорту ще недосконала, реалізовувати його не будемо.

3. Функціональні вимоги

Тут список функціональних вимог до вашого проекту.

Наприклад:

1. Додавання нового супергероя до Ліги Справедливості
2. Моніторинг ураганів
3. Моніторинг пожеж
4. Моніторинг кримінальної активності
5. Члени Ліги можуть спілкуватися між собою через комунікатори Сторожової Застави
6. Якщо інцидент критичний — система викликає додатково Супермена та Диво-Жінку
7. У випадку, якщо інцидент відбувся у Ґотем-Сіті, необхідно спершу отримати дозвід Бетмена на втручання

4. Сценарії

Не забудьте описати сценарії використання вашої системи.

Наприклад:

4.1. Реагування на цунамі у Ґотем-Сіті

1. Система моніторингу за природними катаклізмами аналізує стан океану
2. У разі виявлення перших ознак цунамі в напрямку Ґотем-Сіті, система одразу повідомляє Бетмена про небезпеку та просить дозволу для інших членів Ліги Справедливості втрутитися
3. У разі відмови Бетмена система закриває інцидент
4. У разі отримання дозволу від Бетмена
   1. Система повідомляє інших найближчих учасників Ліги про інцидент
   2. Система слідкує за перебігом інциденту і у разі необхідності направляє додаткових учасників для його вирішення