Простые правила сложного текста - что нового для QA.

Сегодня посмотрел видео Максима Ильяхова "Простые правила сложного текста" - как создавать сильные тексты: лаконичные, информативные и ясные.

За 12 минут научиться составлять идеальные тексты практически невозможно, но давайте попробуем взять 20%, которые могут дать нам 80% результата уже сейчас.

Посмотрим на ценность данной записи с точки зрения QA, где нам может пригодиться умение создавать тексты:

• пишем е-мейл заказчику или менеджеру;
• пишем тест-план,или ежедневный, еженедельный или другой еже-отчет;
• пишем и обновляем тест-кейсы;
• заводим и описываем баги;

Ниже - советы Максима с моими примерами из жизни QA-инженера.

1. Стоп-слова. Избавляемся от страдательного залога -> сделаем мощное предложение с подлежащим и сказуемым.

• Новая функциональность будет протестирована за 2 дня. Тестирование будет выполнено Василием. -> Василий протестирует функциональность за 2 рабочих дня (16 часов).
• Тест-кейс (или, например, user story) будет написан в течение 30 минут -> Мы напишем (или, если один человек занимается, укажем его) тест-кейс через(user story) (или "Тест-кейс будет готов за") 30 минут.
• В рамках стратегии тестирования, рекомендованной нашей компанией Х, будет выполнен полный прогон тестов (full test run) на демо-версии и приемочное тестирование (acceptance testing) на продакшне. -> Отдел тестирования компании Х выполнит полный прогон тестов (full test run) на демо-версии и приемочное тестирование (acceptance testing) на продакшне.

2. Работа с определениями:
а) Усилители: абсолютный, безусловный, весь, каждый, очень, весьма, сильно, крайне, действительно, по-настоящему.

• Мы выполним абсолютно все тесты, сборка безусловно рекомендуется к поставке, по-настоящему стабильный билд.

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

б) Размытые, неточные понятия: один из, в десятке

• Василий является одним из лучших специалистов по тестированию в нашей команде (команда - это сколько человек? В чем он лучший - тест-дизайн, выполнение тестов, автоматизация, управление командой и т.д.)

в) Качественные прилагательные, есть спорные

• хороший билд- это какой, качественный и стабильный билд- это насколько качественный и стабильный?

Каждый новый усилитель делает фразу еще хуже.
Вывод: заменяем определения фактами и цифрами. Пишем по существу.

3. Паразиты времени: прошедшее время - уточняйте. Настоящее время - убирайте (сегодня, в наше время, сейчас. Исключение - если текст постоянно отсылает читателя к прошлому, или говорит о будущем, в редких случаях переключая на настоящее - оставляем).

• В настоящее время в наши дни билд протестирован на 90% (Убираем, так как вместе с тем человеком, которым мы обсуждаем статус тестирования билда - менеджер проекта, или заказчик - мы находимся в одном времени).
• На сегодняшний день количество открытых дефектов в сборке составляет 25 штук -> Сборка содержит (или "последняя версия сборки содержит") 25 открытых дефектов.

4. Модальные глаголы

• пользовательская история - вы можете отправить заявку на активацию аккаунта, заполнив форму и  нажав кнопку Send внизу страницы. ->  

Здесь можно поработать с историями, используя модель INVEST, например так или так. Но не так, как у Дилберта :)

В результате у вас получится следующая пользовательская история.

• Как пользователь, я хочу иметь возможность отправить заявку на активацию аккаунта. Приемочные критерии:

• логин и пароль существуют
• аккаунт не активирован
• и т.д.

Плюс, очень хороший пример приведен в самой лекции (пригодится и при конспектировании, и при выступлении: не усложняйте то, что можно сказать проще):

• Пользователи могут сохранить файл, нажав сочетание клавиш CTRL + S -> Сохранить файл - CTRL + S

5. Фразы с отглагольными существительными - слабое воздействие, превращаем в глаголы.

• Мы осуществляем тестирование продукта, написание тест-кейсов по документации, выполнение тестов, формирование отчетов о тестировании (как будто QA-отдел сам стесняется того, чем занимается) -> Мы тестируем, пишем тест-кейсы по документации, выполняем тесты, формируем отчеты о тестировании.

BONUS: практически все приведенные советы можно использовать для писем и отчетов (первые два пункта, где может пригодиться умение создавать тексты), а про написание тест-кейсов вы можете почитать у Алексея Лупана, про отчеты об ошибках - посмотреть выступление Сергея Атрощенкова на Конфетке-2012.

На сегодня все, оставайтесь с Qastugama!