Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Тестові сценарії та тест-кейси описуються окремо до кожної розробки.

Вимоги до документування

Загальні вимоги

  • Всі документи мають бути структурованими та актуальними

  • Використання уніфікованого формату для всіх документів одного типу

  • Використання Confluence, Google Docs для створення документації

  • Оновлення документації разом зі змінами в коді або логіці системи.

  • Наявність версійності (збереження історії змін документів).

Види документації

Технічні вимоги - загальні бізнес-вимоги

Технічне завдання - детальна технічна специфікація (функціональні та нефункціональні вимоги)

Техно-робочий проект - схема архітектури (залежності, компоненти, API).

Документація коду

  • Коментарі у коді відповідно до стандартів (PEP-257 для Python)

  • README.md у кожному модулі (опис, як розгорнути, залежності).

  • Документація для розробників (Developer Guide).

Документація тестування

  • Тестові сценарії

  • Тест-кейси

Документація користувача

  • Інструкції (User Guide) – як користуватися системою (для внутрішніх клієнтів або майданчиків).

Контроль якості документації

  • Аудит документації з певною періодичністю

  • Відповідальність за оновлення (наприклад, аналітик оновлює технічні вимоги разом із аналізом змін по CR).

Джерела розробки


Порядок внесення змін і доповнень до технічного завдання

...


Висновки


Додатки

1) план розробки засобу інформатизації;
2) інші додатки (у разі їх наявності).