База знань

Тестування документації

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

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

Тестування документації дозволяє оцінити різні характеристики документів і вимог: повнота і надмірність, однозначність і несуперечливість, ранжируваність, достовірність і перевірюваність.

Тестування документації рекомендується проводити при створенні нового ПЗ або при його зміні у зв’язку з розвитком бізнесу. Тестування документації краще починати на етапі створення вимог до системи, це дозволить усунути частину дефектів до їх реалізації в коді.

Ключові переваги:

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

Тестування документації включає тестування декількох рівнів документації:

  • Бізнес-вимоги
  • Функціональні вимоги
  • Технічне завдання
  • Керівництво користувачів

Давайте спробуємо зібрати в єдине критерії тестування, що утворюють квінтесенцію якісної документації. Буде справедливо, якщо ми опустимо таке всім зрозуміле правило, як граматика, так як не в ній одній таїться успішний реліз.

Основні вимоги до документації:

  • Повнота і відповідність дійсності. Будь-яка документація повинна містити опис саме тієї функціональності, яка присутня в додатку. І даний опис повинен стосуватися абсолютно всієї функціональності, а не тільки найбільш значущої.
  • Навігація. І не просто навігація, а зручна навігація. У користувача ніколи не повинно виникати проблем з пошуком необхідної йому інформації. Всі дерева файлів, закладки та інше повинні бути на видному місці відразу, як користувач відкриває документ. Покажчик, пошук – повинно бути присутнім все, що допоможе знайти рішення або опис проблеми.
  • Структурованість документації. Всі документи повинні знаходиться в повному порядку, по розділах. Текст повинен бути також з чіткою структурою – щоб можна було в будь-який момент згадати, де зупинився або зрозуміти, в якому абзаці міститься саме та інформація, яка нам необхідна.
  • Інструкції повинні бути присутнім скрізь. Навіть при виконанні абсолютно однакових маніпуляцій з програмою – необхідний покроковий опис дій у всіх випадках. Це може бути, як і пряме повторення інструкцій, так і посилання на вже існуючі.
  • Терміни та їх значення. У будь-якої документації може використовуватися багато термінів, абревіатур і скорочень. Кожна з цих сутностей повинна мати своє значення і розшифровку.
  • Доступність користувачеві. Документація повинна бути максимально зрозумілою для будь-якої цільової аудиторії.

 

Набагато більше інформації на курсі базовий модуль тестування