Home

Автор: Кристин Джеквони (Kristin Jackvony)
Оригинал статьи
Перевод: Ольга Алифанова

После многих лет работы в тестировании программного обеспечения можно с уверенностью сказать: почти никто не любит писать документацию. Даже люди, которым нравится писать (как мне), могут полагать, что есть дела и поинтереснее – например, создание тест-планов или автоматизации тестов. Но документация крайне важна! В этой статье я расскажу о пяти причинах этого, а также поделюсь пятью стратегиями, которые помогут вашей команде или компании иметь качественную документацию.

Причина 1: Это полезно вам

Думайте о документации как о письме от вашего прошлого «я» к настоящему. Часто в тестировании приходится настраивать сложные конфигурации приложения. Помните ли вы все детали каждой настройки? Я — нет! Поэтому я делаю заметки о том, что делала, и храню их так, чтобы легко было найти в следующий раз. Когда нахожу нужную документацию, обычно вслух говорю: «Спасибо, прошлая я!»

Причина 2: Это полезно вашей команде

Со временем вы усваиваете детали, которые новым участникам команды могут быть неочевидны. Например, данные для входа тестовых пользователей. Если их не записать, коллеги будут постоянно отвлекать вас, спрашивая эти данные. Гораздо проще задокументировать их один раз в доступном месте, чтобы каждый мог легко их найти.

Причина 3: Это полезно людям за пределами вашей команды

Ваша команда, вероятно, обладает специализированными знаниями о продукте, которых нет у других. Чем больше вы задокументируете, как настроить функцию, пользователей, как тестировать, ответы на типовые вопросы и способы устранения проблем, тем меньше вам придётся отвлекаться, помогая другим.

Причина 4: Это помогает не пропустить требования

Однажды мне нужно было тестировать переписанную важную функцию с десятками настроек и сотнями комбинаций тестов. Функции не были задокументированы, и я вынуждена была догадываться, экспериментировать и спрашивать менеджера продукта. В итоге перед релизом обнаружилось, что один важный параметр не был реализован, потому что мы о нём не знали! Документация всех настроек предотвратила бы эту проблему.

Причина 5: Это помогает не пропустить тест-кейсы

Подумайте о самом сложном продукте, который вы тестировали. Помните ли вы все способы его тестирования? Документирование работы продукта, всех настроек и пользовательских сценариев крайне полезно для планирования регрессионного тестирования. Так вы снизите риск упустить важный тест-кейс. А документация регрессионного плана для повторного использования — отличная идея.

Теперь несколько стратегий для поддержания качественной документации:

Стратегия 1: Понимайте, что не все хорошо пишут документацию

Если заставлять всех по очереди писать документацию, качество будет разным. Не каждый умеет разбирать сложную тему на части и ясно их описывать. Будьте готовы тратить время на исправление плохо написанных материалов.

Стратегия 2: Люди, которым удаётся писать документацию хорошо, обычно делают это с меньшим отторжением

Существуют люди, которым нравится находить самый ясный способ объяснить что-либо — например, технические писатели. Если таких в вашей команде нет, найдите разработчиков, тестировщиков или менеджеров продукта, которые умеют объяснять, и попросите их создавать документацию.

Стратегия 3: Не оставляйте документацию на одного человека

Если возложить эту задачу на одного человека, он может начать её ненавидеть, потому что придётся отвлекаться от основной работы. Делите нагрузку хотя бы на двоих.

Стратегия 4: Планируйте время на документацию

Тестировщикам и разработчикам сложно балансировать между созданием и выполнением тест-планов, автоматизацией и исправлением багов. Встройте задачи по документации в спринт, выделите один день в месяц или один спринт в квартал для документации. Это снижает стресс и помогает соблюсти баланс.

Стратегия 5: Поддерживать документацию проще, чем создавать с нуля

Начав документировать, кажется, что это займёт вечность. Но после того, как документация написана, поддерживать её намного проще — нужно лишь обновлять при изменениях. Регулярный обзор помогает держать документацию на виду, а коллеги смогут самостоятельно находить нужную информацию, снижая количество отвлекающих факторов.

С правильным подходом и планированием команда может создать полезную документацию, которая будет служить и самим участникам, и другим сотрудникам компании, помогая выпускать качественные продукты вовремя.

Обсудить в форуме