База знань

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

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

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

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

Тож почнемо:

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

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