Как стать автором
Обновить

Пользовательская документация в пайплайне разработки, или как мы делаем лучший портал поддержки софта для ритейла

Время на прочтение10 мин
Количество просмотров3.1K
Всего голосов 8: ↑8 и ↓0+8
Комментарии6

Комментарии 6

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

Как устроено само написание документации? Я надеюсь, это markdown-like доки под системой контроля версий, которые только публикуются в confluence, так?

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

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

Портал поддержки и вправду очень хороший и выручал не раз, но для себя отметил что очень не хватает информации с какой версии ПО наблюдается баг указанный в очередном обновлении. Попробую описать почему для меня становится данный функционал критичным, в ближайшее время вся розница должна начать вывод маркированной молочной продукции. Вы в своих информационных рассылках указали, что для корректной работы с маркированной молочной продукцией необходимо обновиться до Set Retail 10.3.14, который выйдет 8 августа. При этом данную версию ПО ещё не опубликовали в публичный доступ (скорее всего сейчас её тестируют на части клиентов). Понимая что 1.09 не за горами, я думал обновить кассовое ПО на версию ближе к актуальной. Последние несколько раз мне так везёт, что я умудряюсь обновиться именно до тупикового патча, с которого исходя из документации можно выбраться обновляясь через релиз. Была мысль обновиться до версии 10.3.13.0 и ждать когда опубликуют патч перехода на версию 10.3.14, но в описании к патчу 10.3.13.5 есть упоминание:

Bugs:   [SRTS-899] - При загрузке переоценки удаляются все значения МРЦ товара в таблице un_cg_productciggy_price

И получается что не понятно в какой именно версии вылез этот баг с которым нам вовсе не хотелось бы столкнуться вживую. При этом, если я обновлюсь сразу до 10.3.13.5 я рискую опять попасть в тупиковую ветвь патчей. Получается какой-то замкнутый круг, мне приходится сидеть и ждать публикации 10.3.14, чтобы точно знать с какого патча 13-той версии можно будет обновиться на 14-тую, при этом хотелось бы задействовать часть функционала который используется в 13-той версии (на тестовый стенд я её уже установил).

Также хочу отметить последнее время участились случаи описания патчей фразами:

Изменения в версии 10.3.13.7

Bugs:
Исправлены ошибки и замечания

Изменения в версии 10.3.13.8

Bugs:
Исправлены ошибки и замечания

и остаётся только гадать какой модуль исправлялся и где можно словить проблемы после обновления.

Вот приятно получать такие фидбеки с конструктивной критикой. Спасибо большое.

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

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

  3. Относительно тупиковых патчей, да есть такое, но это связано с тем, что выходят исправления для веток, которые еще не обновлены, но мы не стоим на месте, в будущем решим этот вопрос.

  4. Относительно нейминга фичей именно в changelog, это задача как раз есть и над ней тоже работаем, так как она явно публикуется у нас автоматически прямо из сборщика на портал.

Еще раз спасибо вам.

Добрый день! Подскажите, а уход Atlassian с рынка никак не сказался на вашей деятельности?

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

Зарегистрируйтесь на Хабре, чтобы оставить комментарий