Смартсорсинг.ру

13 и 14 декабря пройдет двухдневный онлайн мастер-класс "Легкая" документация в тестировании от специалиста тестирования Алексея Федорова и QAS Training Center компании Softengi.  Алексей Федоров - разработчик систем тестовой документации в ИТ-компаниях, “сердце” Санкт-Петербургского сообщества тестировщиков. Он разработал и внедрил “с нуля” системы документации. 

Документация к продукту — это достаточно общее понятие; часто мы используем его, не уточняя, что именно подразумевается. Технические писатели, разработчики, тестеры и руководство видят проблему разработки описаний со своей стороны, поэтому иногда не могут договориться, чтобы создать общий полезный продукт. В идеале разработкой документации должно заниматься отдельное подразделение, тесно связанное с тестерами, разработчиками и, что важно, пользовательской аудиторией. В реальности даже в крупных зарубежных компаниях, годами оптимизирующих рабочий процесс, все работает не совсем так. О российских реалиях даже не говорю: работая техническим писателем в течение многих лет, мне практически не доводилось встречать организации, где бы при постоянном развитии крупного продукта документация была всегда полной, актуальной и понятной конечному пользователю.

«Если у вас ничего не получается — прочтите, наконец, инструкцию…», — гласит народная мудрость, предполагающая, что каждый сложный агрегат должен иметь собственную инструкцию по применению. Но из воздуха такие тексты не появляются. Над их созданием загодя трудится технический писатель, необходимый для принятия конечными пользователям продукта ИТ-отдела также, как, например, дизайнер интерфейсов.

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

Удобство работы конечного пользователя является критическим для успеха любого ИТ-проекта, цель которого — выйти за рамки создавшей его группы и отправиться покорять массы. С этим мало кто возьмется спорить. Традиционно удобство связывают с эргономикой интерфейса (usability). Но где-то на границе между usability и технической частью проекта находится не менее важная область — техническая документация, которая объясняет пользователю, как это эргономичный интерфейс должным образом использовать.