Проектирование веб-приложения для генерирования и публикации документов

Данная работа посвящена проектированию сервиса для автоматической сборки и публикации технической документации. В условиях активно развивающегося рынка программного обеспечения задача быстрой доставки пользователям актуальной технической документации – основного источника информации о продукте, – становится всё более актуальной. Так как техническая документация затрагивает множество сфер, включая разработку программного обеспечения, взаимодействие с пользователями и управление знаниями, в этой области идут активные исследования. В том числе эти исследования касаются автоматизации сборки документов для упрощения работы технических писателей. Основными проблемами технической документации признаны её неполнота и неактуальность. Их источником в большинстве случаев становится многоступенчатый процесс сборки и публикации, включающий в себя взаимодействие с большим количеством программ. Такой процесс требует длительного времени и усилий, а также освоения большого количества программ. Он неустойчив к человеческим ошибкам и в целом мешает техническим писателям поддерживать документацию актуальной и быстро её обновлять. Целью данной работы является прототипирование сервиса, который решит проблему сложного многоступенчатого процесса сборки и позволит техническим писателям быстро собирать и публиковать документы. Разработка прототипа осуществлялась в соответствии с подходом Contextual Design, и включала в себя анализ предметной области и существующих решений и сбор пользовательских данных с помощью интервью и контекстного интервью. На основе полученных данных были выделены основные потребности пользователей: дистанционная сборка и публикация документов и управление базой документов; сборка документов различных форматов из одного источника; отображение отчёта о результатах сборки со списком повреждённых разделов. Для иллюстрации реализации данных потребностей с помощью сервиса была описана логика нового процесса сборки документов, а также спроектирован прототип с низкой степенью детализации и предварительный вариант прототипа с высокой степенью детализации. Прототип низкой детализации был протестирован на выполнение ключевых задач с помощью метода тестирования первого клика. Тестирование показало, что большинство писателей смогли решить поставленные задачи и положительно оценили новые функции сервиса. К ограничениям проведённого исследования относится небольшая целевая аудитория и малое число пользователей, участвовавших в интервью и тестировании. Это связано с тем, что прототип разрабатывался под нужды конкретной команды технических писателей, её процесс работы над документами и используемые инструменты. Также стоит отметить, что прототип реализован в низкой детализации и не был оценён экспертами в области проектирования. Текущие ограничения определяют возможное развитие сервиса. К нему относятся экспертная оценка прототипа низкой детализации, его дальнейшая доработка до уровня высокой детализации и полноценное тестирование с учётом всех функций сервиса. Кроме того, возможно последующее расширение области использования прототипа на другие команды, работающие с документацией, и адаптация под другие стандарты создания документации для создания более универсального прототипа.