Загальні відомості про засіб інформатизації
1) найменування засобу інформатизації, його замовника та виконавця (розробника);
2) перелік документів, на підставі та з урахуванням яких створюється (модернізується, модифікується, розвивається) засіб інформатизації, ким і коли затверджено ці документи;
3) відомості про призначення та цілі засобу інформатизації;
4) план-графік виконання етапів із створення (модернізації, модифікації, розвитку) засобу інформатизації із зазначенням строків початку та закінчення робіт за кожним із етапів.
Відомості про робочий процес (бізнес-процеси) та пов’язані з ними об’єкти інформатизації, умови їх експлуатації та характеристики
Вимоги до засобу інформатизації
Склад та зміст робіт із створення (модернізації, модифікації, розвитку) засобу інформатизації.
Опис функціональних вимог. Надається в кожному ТЗ окремо і містить детальний опис, який відповідає на питання "що ми робимо в цій розробці"
Порядок контролю та приймання робіт із створення (модернізації, модифікації, розвитку) засобу інформатизації.
Основні етапи порядку контролю та приймання:
Планування робіт – Визначення тестових сценаріїв
- Документальне оформлення – написання тест-кейсів
Контроль якості – Перевірка, що реалізація відповідає вимогам
Демонстрація функціональності – проводиться демо за необхідності
Фінальне затвердження – звітування щодо статусу тестування та прийняття рішення про введення в експлуатацію.
Тестові сценарії та тест-кейси описуються окремо до кожної розробки.
Вимоги до документування
Загальні вимоги
Всі документи мають бути структурованими та актуальними
Використання уніфікованого формату для всіх документів одного типу
Використання Confluence, Google Docs для створення документації
Оновлення документації разом зі змінами в коді або логіці системи.
Наявність версійності (збереження історії змін документів).
Види документації
Технічні вимоги - загальні бізнес-вимоги
Технічне завдання - детальна технічна специфікація (функціональні та нефункціональні вимоги)
Техно-робочий проект - схема архітектури (залежності, компоненти, API).
Документація коду
Коментарі у коді відповідно до стандартів (PEP-257 для Python)
README.md у кожному модулі (опис, як розгорнути, залежності).
Документація для розробників (Developer Guide).
Документація тестування
Тестові сценарії
Тест-кейси
Документація користувача
Інструкції (User Guide) – як користуватися системою (для внутрішніх клієнтів або майданчиків).
Контроль якості документації
Аудит документації з певною періодичністю
Відповідальність за оновлення (наприклад, аналітик оновлює технічні вимоги разом із аналізом змін по CR).
Джерела розробки
Порядок внесення змін і доповнень до технічного завдання
Висновки
Додатки
1) план розробки засобу інформатизації;
2) інші додатки (у разі їх наявності).