Всё для технического документирования
+7 (925) 328-76-00
Разработка технической документации
Курсы для технических писателей
Программное обеспечение

Эджайл и технические коммуникации: задаче-ориентированный контент в функцие-ориентированном процессе

20.08.2014

Ojective(Lens glass) isolated ion white.Мы продолжаем уже знакомую вам серию статей от Алиссы Фокс. Она детально углубляется во все тонкости эджайл-процессов и создаёт публикации, чтобы предостеречь нас от возможных ошибок.


Как я уже говорила в статьях Эджайл и технические коммуникации: командный подход ранее в этом году, авторы должны включать задачи своей работы в те же пользовательские истории, которые включают задачи отделов разработки и контроля качества. Такой подход гарантирует, что каждая пользовательская история действительно будет завершена в конце спринта, и помогает членам эджайл-команды из всех функциональных областей работать вместе, чтобы создавать «потенциально готовый к релизу» продукт в каждом спринте.

Несмотря на очевидные преимущества командного подхода, если вы не будете осторожны, структура эджайл-процесса может диктовать, какой контент вы будете писать. Поскольку команды часто попадают в ловушку, определяя пользовательские истории как функции, ваш контент может попасть в ту же ловушку – вы в конечном итоге задокументируете продукт, а не начнёте решать проблемы ваших пользователей с продуктом. Эта статья предлагает некоторые размышления для создания ориентированного на задачи (т.н. «задаче-ориентированного») контента, помогая сфокусировать контент на том, что необходимо пользователям для работы.

Какую работу и результаты стоит иметь в виду

Создание контента для пользователя требует гораздо большего, чем просто способность написать документацию. Оно требует умение осмысливать, планировать, навыки структурирования информации и установки виртуальных машин, проведения опроса экспертов по предмету, внимание к пользовательским характеристикам и многое другое. Начиная новый эджайл-проект, во время планирования релиза вы должны принять во внимание все эти пункты и определить, что вам нужно сделать и что вы планируете выпустить в данном релизе. Полезно также продолжить создавать «документационные планы», разработанные с учётом рабочего стиля и результатов работы определённой команды.

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

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

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

Те же принципы применяются для видеоконтента. Иногда вам может понадобиться задокументировать особенно сложную процедуру или сложную идею в видео. В то время как некоторые из этих запланированных видео могут вписаться в существующую пользовательскую историю, как вы впишете работу, связанную с этими крупными, всеобъемлющими концепциями в рамки эджайла?

Контент превалирует над процессом

Работа в эджайл-среде не означает, что члены команды должны придерживаться жёсткого процесса без отклонений. Сам термин «эджайл» подразумевает текучесть процесса, которую команда может использовать, чтобы закончить работу наиболее эффективным для данной команды образом. Самое главное – помнить, что ваш контент превалирует над ??процессом. Контент находится на первом месте, и ваш процесс должен позволять создавать нужный контент в желаемых форматах эффективно и результативно.

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

Пока вы ещё не можете проводить тесты удобства использования на данном этапе (потому что для тестирования нужны прототипы или код), но постарайтесь начать тестирование, как только это станет возможным. В этом случае у вас будет возможность получить обратную связь от тестов и, возможно, провести их повторно. И снова создавайте пользовательские истории специально для таких тестов, если они не вписываются в существующие.

Наконец, использование командного подхода как для разработки контента, так и для тестирования, подтверждает идею о том, что высококачественный продукт – ответственность всей команды. Эджайл не требует, чтобы у вас были только пользовательские истории, на основе которых отдел разработки пишет код, отдел контроля качества проводит тестирование, а отдел информационного развития проводит разработку контента и/или тестирование на пользовательские характеристики. Если кто-то в команде может делать не только свою работу и может помочь с разработкой контента, пусть! Отслеживайте работу в спринте и не позволяйте функциональным ролям диктовать, кто что делает. Команда – это коллектив, который работает вместе, чтобы создавать соответствующий продукт и контент.

Заключение

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

Источник: Agile and Tech Comm: Task-Focused Content in a Feature-Focused Process

Тэги: , , ,

< Вернуться к списку публикаций

Облако тегов