Тестова документація в тестуванні програмного забезпечення (приклад)

Що таке тестова документація?

Тестова документація — це документація артефактів, створених до або під час тестування програмного забезпечення. Вона допомагає команді тестувальників оцінити необхідні зусилля, відстежувати ресурси та прогрес, а також забезпечити адекватне охоплення тестуванням. Записи та звіти про тестування — це повний набір документів, які дозволяють вам описувати та документувати планування тестування, розробку тестування, виконання тестування та результати тестування, отримані в результаті тестування.

👉 Зареєструйтесь на безкоштовний проект тестування програмного забезпечення в реальному часі

Чому потрібна формальність тестування?

Для новачка легко припустити, що тестування – це виконання різних розділів коду на ситуативній основі та перевірка результатів. Але в реальному світі тестування є дуже формальною діяльністю, яка детально документується. Тестова документація спрощує, а також робить перевірку можливою.

Ступінь формальності тестування залежить від:

• Тип тестованої програми (AUT).
• Стандарти, яких дотримується ваша організація.
• Зрілість процесу розвитку.

Тестові дії зазвичай займають від 30% і 50% загальних зусиль з розробки програмного забезпечення. Документація допомагає визначити покращення процесу тестування, які можна застосувати до майбутніх проектів.

Які є типи тестової документації?

Ось важливі типи тестової документації:

«На практиці ці документи створюються на різних етапах — від раннього планування (політика тестування, стратегія) до виконання та закриття (звіти про дефекти та зведені звіти)».

Види тестових документів	Опис
Політика тестування	Це документ високого рівня, який описує принципи, методи та всі важливі цілі тестування організації.
Тест стратегії	Документ високого рівня, який визначає рівні (типи) тестування, що мають бути виконані для проекту.
План випробувань	План тестування – це повний документ планування, який містить обсяг, підхід, ресурси, графік тощо заходів тестування.
Матриця простежуваності вимог	Це документ, який пов'язує вимоги з тестовими випадками.
Сценарій тесту	Сценарій тесту це елемент або подія програмної системи, яку можна перевірити одним або кількома тестовими випадками.
Тестовий випадок	Це група вхідних значень, передумов виконання, очікуваних постумов виконання та результатів. Вона розроблена для тестового сценарію.
Дані тесту	Тестові дані – це дані, які існують до виконання тесту. Вони використовуються для виконання тестового випадку.
Звіт про дефект	Звіт про дефект – це задокументований звіт про будь-який недолік у програмній системі, який не виконує свою очікувану функцію.
Підсумковий звіт про тестування	Звіт про зведення тестування – це документ високого рівня, який підсумовує проведені тестові дії, а також результати тестування.

Які найкращі практики для досягнення тестової документації?

У цьому розділі ми ознайомимося з найкращими практиками, які допомагають досягти результатів тестової документації, з прикладами, які допоможуть вам краще її зрозуміти:

• Залучайте відділ контролю якості на ранній стадії проекту: Залучайте команду контролю якості з самого початку проєкту, щоб тестова документація розроблялася разом із дизайном продукту та вимогами.
  приклад: Відділ контролю якості співпрацює під час планування спринту для створення початкових тестових випадків на основі історій користувачів.
• Підтримуйте документи в актуальному стані: Не створюйте тестові документи та не забувайте про них — оновлюйте їх щоразу, коли змінюються вимоги або функції.
  приклад: Коли API входу змінюється, негайно оновіть пов'язані тестові випадки та результати.
• Використання контролю версій: Керуйте та відстежуйте всі зміни в тестових документах за допомогою систем контролю версій, щоб уникнути плутанини та втрати даних.
  приклад: Зберігайте плани тестування на GitHub, щоб мати чітку історію версій та можливості відкату.
• Документ для ясності та мети: Записуйте лише те, що допомагає вам та вашим зацікавленим сторонам зрозуміти хід тестування та очікувані результати.
  приклад: Включіть звіти з підсумками тестування, в яких виділено пройдені, не пройдені та заблоковані тестові випадки, для розгляду керівництвом.
• Використовуйте стандартні шаблони: Дотримуйтесь узгодженого формату, такого як шаблони Excel або Word, щоб полегшити створення та перегляд документації.
  приклад: Використовуйте стандартний «Шаблон тестового випадку» з полями для ідентифікатора, опису, передумов та очікуваних результатів.
• Централізуйте зберігання документів: Зберігайте всі документи, пов’язані з проектом, в одному доступному місці, щоб члени команди могли легко звертатися до них або оновлювати їх.
  приклад: Зберігайте артефакти тестів у спільному Google Drive папка, доступна всій команді QA та розробників.
• Включіть достатньо деталей: Уникайте розпливчастої або неповної інформації; детальна документація покращує розуміння та зменшує кількість помилок під час виконання тесту.
  приклад: Замість «Перевірити вхід» напишіть «Перевірка входу користувача з дійсними обліковими даними успішно перенаправляє на панель керування».

Коли слід створювати тестову документацію для тестування програмного забезпечення?

Ось деякі ключові моменти щодо того, коли слід створювати тестову документацію для тестування програмного забезпечення:

• Етап планування: Перш ніж розпочати виконання тестування, чітко визначити обсяг, цілі та стратегію тестування.
• Підготовка до тесту: Під час планування тестування ефективно встановлювати терміни, ресурси та вимоги до середовища.
• Аналіз вимог: Після аналізу вимог, забезпечити повне охоплення функціональних та нефункціональних специфікацій.
• Стандартизація дизайну: Перед розробкою тестових випадків необхідно стандартизувати формати та забезпечити відстеження всіх документів.
• Документація сценарію: Під час розробки тестів, для документування сценаріїв, вхідних даних, очікуваних результатів та деталей тестових даних.
• Готовність до виконання: Перед виконанням тестування перевірити готовність тестового середовища, інструментів та точність документації.
• Оцінювання після: Після тестування, зафіксувати результати, дефекти та отримані уроки для покращення процесу.

Які типи шаблонів потрібні для тестової документації?

Ось деякі шаблони, які вам знадобляться для тестової документації з тестування програмного забезпечення:

Назва шаблону	Інструменти
Шаблон плану тестування	Microsoft Word, Google Docs або Confluence для спільного редагування та контролю версій
Шаблон тестового випадку	TestRail, Zephyr (у JIRA), Xray або Excel/Google Sheets для структурованого управління тестами
Шаблон тестового сценарію	JIRA, TestLink або Google Sheets для документування умов високорівневого тестування
Шаблон матриці відстеження вимог (RTM)	Excel, Google Таблиці або TestRail для зіставлення вимог з тестовими випадками
Шаблон звіту про дефекти	JIRA, Bugzilla або Azure DevOps для реєстрації та відстеження дефектів
Шаблон підсумкового звіту про тестування	Злиття, Google Docs або TestRail для компіляції результатів тестування та аналізу

Плюси та мінуси тестової документації

Плюси

• Головною метою створення тестової документації є зменшення або усунення будь-яких невизначеностей щодо тестової діяльності. Це допомагає усунути неоднозначність, яка часто виникає, коли йдеться про розподіл завдань.
• Документація пропонує не лише систематичний підхід до тестування програмного забезпечення, але він також виступає як навчальний матеріал для новачків у процесі тестування програмного забезпечення.
• Це служить гарною маркетинговою та збутовою стратегією для демонстрації тестової документації, що демонструє зрілий процес тестування.
• Тестова документація допомагає вам запропонувати клієнту якісний продукт у встановлені терміни.
• In Розробка програмного забезпеченняТестова документація також допомагає налаштувати або встановити програму за допомогою документа конфігурації та посібників оператора.
• Тестова документація допомагає вам покращити прозорість у взаємодії з клієнтом.

мінуси

• Вартість документації може перевищувати її вартість, оскільки це займає багато часу.
• Часто її пишуть люди, які не вміють добре писати або не знають матеріалу.
• Відслідковувати зміни, які вимагає клієнт, і оновлювати відповідні документи втомлює.
• Погана документація безпосередньо відображає якість продукту, оскільки може виникнути непорозуміння між клієнтом та організацією.

Типові помилки, яких слід уникати в тестовій документації

Ось найпоширеніші помилки, яких слід уникати в тестовій документації:

1. Уникайте написання нечітких або двозначних описів тестових випадків.
2. Не пропускайте документування передумов тестування та залежностей.
3. Ніколи не забувайте включати очікувані результати для кожного тесту.
4. Уникайте невідповідного форматування в різних тестових документах.
5. Не використовуйте розпливчасті або невимірні цілі тестування.
6. Ніколи не пропускайте контроль версій для оновлень тестової документації.
7. Уникайте дублювання інформації між кількома артефактами тестування.
8. Не нехтуйте перевіркою документації на предмет її точності та повноти.

Поширені запитання