Руководство пользователя портала комфортная городская среда

В ходе данного проекта помогли с оформлением документа "Руководство пользователя" для портала "Комфортная городская среда". Портал посвящен благоустройству городов и позволял проводить голосование по благоустройству конкретных городских объектов на веб-портале, в мобильном приложении (в том числе с участием волонтеров с планшетами, проводивших опросы в уличных условиях).

Работа выполнялась в рамках федерального проекта "Формирование комфортной городской среды". Одним из требований проекта было оформление документации по ГОСТ 34 серии и ГОСТ ЕСКД (в частности ГОСТ 2.105 несмотря на то что это программный документ). Для нас это не было чем-то новым т.к. требования к документации порой бывают достаточно специфичными и часто зависят от требований на вышестоящие документы или требований ТЗ, принимающей стороны. 



В качестве исходных данных был предоставлен доступ к разработанному порталу и мобильному приложению с разными ролями пользователей (оператор, администратор портала). И т.к. проект был создан на базе решения "1С Битрикс" редакции "Малый бизнес" были предоставлены ссылки на документацию данного продукта.



Особенностью данной работы было то, что функционал "был готов не на 100%", пришлось учесть данные обстоятельства и в первую очередь описывать уже готовый функционал, а для остального оставлять пустые места. В ходе работ пришлось дорабатывать и описание на уже готовый функционал. Мы с пониманием относимся к такого рода вещам и не считаем это двойной работой, просто очередная итерация документа.  

Отдельно стоит упомянуть описание работы с мобильным приложением. Для изучения функционала было установлено специализированное ПО для просмотра функционала мобильных приложений в среде ОС Windows. Что позволило посмотреть как кроссплатформенность (ios, android) так и быстро сформировать адаптированные к мобильному экрану скриншоты.