company_banner

YouTrack теперь с базой знаний

    Привет, Хабр!

    На связи команда Youtrack из JetBrains. Наши пользователи очень давно просили нас придумать что-то, что позволило бы им хранить документацию прямо в трекере. И вот в рамках мажорного релиза 2020.2 произошло важное событие: в YouTrack появилась база знаний. Теперь вы можете собирать полезную информацию для работы в одном месте и хранить внутреннюю документацию прямо в YouTrack, бок о бок с проектами и задачами, а ваши внешние пользователи смогут находить ответы на свои вопросы прямо в трекере.

    image

    За подробностями добро пожаловать в пост.

    Что это такое?


    Мы не стали изобретать велосипед: наша база знаний — это набор статей. Статьи организуются в древовидную структуру, корнем которой является проект: таким образом, у каждого проекта может быть разветвленная структура статей.

    image

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

    Итак, помимо собственно создания статей, вы сможете:
    1. Искать нужные статьи с помощью полнотекстового поиска.
    2. Использовать WYSIWYG или Markdown-редактор.
    3. Создавать разнообразный контент, используя таблицы, чек-листы и упорядоченные списки, а также прикрепляя или встраивая различные медиа — от YouTube-видео до Google-документов.
    4. Обсуждать статьи в комментариях, упоминать коллег и задачи.
    5. Подписываться на уведомления об изменениях и комментариях в интересных вам статьях.
    6. Просматривать предыдущие версии статьи и при необходимости восстанавливать любую из предыдущих версий.
    7. Управлять доступом к статьям как с помощью ролей (мы добавили соответствующие разрешения для управления доступом к статьям на проектном уровне), так и ограничивать видимость отдельных статей (или целых ветвей статей) с помощью списков видимости — точно так же, как для задач.

    Хорошо, и что с этим делать?


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

    Внутренняя документация вашей команды


    Сложно представить современную команду совсем без документации: заметки с совещаний, чек-листы для новых членов команды или даже инструкция по настройке VPN. База знаний YouTrack поможет собрать все в одном месте, и, конечно, это будет полезно не только для команд разработчиков.
    Допустим, вы организуете тимбилдинг для коллег. Чтобы спланировать мероприятие, создайте статью в базе знаний и начните записывать туда свои идеи. YouTrack автоматически сохранит черновик, и вы сможете вернуться к нему в любое время.

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

    image

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



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

    Открытая база знаний для ваших пользователей


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

    Прежде всего разрешите анонимный доступ к вашему серверу YouTrack, чтобы внешние пользователи могли заходить в базу знаний без регистрации. Управление доступом очень гибкое — вы сможете открыть отдельные ветви статей для определенного круга людей: вашей команды, зарегистрированных пользователей или для всех желающих. Теперь осталось только наполнить вашу базу знаний! Пишите статьи, добавляйте таблицы, прикрепляйте файлы и не бойтесь вносить правки — все версии статьи будут доступны на вкладке истории, и вы в любой момент сможете просмотреть разницу между версиями и откатиться к любому из предыдущих состояний.

    image

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

    Поиск по базе знаний


    И в открытых, и в закрытых базах знаний работает полнотекстовый поиск, который находит все статьи, содержащие искомое слово или словосочетание. От результатов поиска легко перейти к нужной статье, чтобы найти ответ на свой вопрос.

    image

    А сами вы в JetBrains этим пользуетесь?


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

    image

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

    А еще что-то интересное есть?


    Конечно, база знаний — это не единственное улучшение в YouTrack 2020.2.

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

    Для продуктивной работы с коллегами из других команд вы можете делиться тегами, сохраненными поисками, Agile-досками и отчетами новым, более гибким способом, а именно поделиться сразу с несколькими группами пользователей.

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

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

      +3
      Отлично, JetBrains создала Confluence. Когда в YouTrack все-таки появится ServiceDesk? Как он будет лицензироваться?
        +4

        Добрый день, спасибо! Сейчас в YouTrack уже есть реализация Helpdesk (service desk) — незарегистрированные пользователи могут создавать задачи по почте и получать уведомления о новых комментариях и изменениях в своих задачах также через емейлы. Такая конфигурация настраивается через почтовую интеграцию и воркфлоу (кстати, благодаря воркфлоу процесс можно кастомизировать самыми разными способами — например, автоматически отслеживать SLA, посылать ремайндеры или автоматически назначать тикеты на ответственного инженера поддержки), а подробности описаны вот тут. Несколько вариантов автоматизации процесса helpdesk можно найти здесь и здесь.
        Наши пользователи успешно используют эту реализацию в своих сценариях — и для поддержки внешних пользователей, которых не хочется регистрировать в трекере, и для административных задач внутри компании (с помощью различных типов задач и автоматизации).


        Однако, нашему helpdesk есть, куда расти — и мы в команде YouTrack как раз сейчас этим занимаемся. В частности, мы планируем ввести интерфейс для репортеров задач — чтобы можно было посмотреть свои тикеты, увидеть их статус и поля, коммуницировать с техподдержкой через комментарии, а не через почту. Также хотим сделать возможность создания тикетов через форму (встроенную на сайт, например) и упрощенный интерфейс списка задач для тех, кому нужна только самая основная информация.
        Касательно вопроса лицензирования — пока что не могу дать комментариев, к сожалению, эта информация будет позже.
        Если у Вас есть какие-то вопросы или если я что-то упустила — буду рада ответить.

          0
          Вы упустили примерный срок появления веб-интерфейса для helpdesk. Этот год? Первая половина следующего?
          Спасибо.
            +2

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

        0

        простите, ответила не в ту ветку, удаляю

          0

          Расскажите, пожалуйста, как оно в сравнении с Notion?

            +2
            Было бы довольно некорректно делать сравнения с нашей стороны. Попробуйте и напишите нам, как оно там, в сравнении с Notion :)
              0
              Мы и правда не можем претендовать на полноценную картинку сравнения:)
              По нашему мнению, главное преимущество базы знаний YouTrack — ее тесная интеграция с трекером, в частности, возможность ссылаться на задачи в статьях и наоборот, использовать списки задач в статьях, оперировать пользовательской базой и т.д.

              Выскажу несколько мыслей от себя:
              1. База знаний YouTrack и Notion разные по своей сложности: если вам нужно вести документацию продукта и сделать FAQ для внешних пользователей, то наша база знаний идеально подойдет, а если вам нужны математические выражения, доска для визуализации документов и сложные структуры — то за этим пока в Notion. В то же время вести заметки с митингов в Notion — это, наверное, оверкилл.
              2. У YouTrack есть standalone версия — это значит, что ваши данные могут храниться у вас на серверах и вы не будете зависеть от third-party инфраструктуры. Некоторым компаниям, например, политики безопасности не позволяют хранить документацию и внутреннюю информацию на чужих серверах.
              3. Вижу, что Notion хранит историю документов только до 30 дней и только в платной версии. В YouTrack срок хранения истории не ограничен.
              4. У нас пока нет совместного редактирования (планируем над этим работать, если будет спрос) — у Notion это есть.
              5. Базой знаний YouTrack, как и самим Ютреком, может бесплатно пользоваться команда до 10 человек (плюс неограниченное количество внешних пользователей, если разрешить анонимный доступ) — так что будем рады, если вы попробуете и расскажете нам, как впечатления:)
                0

                Спасибо большое, это полезно

              +5

              Господи, это теперь вместо JIRA и Confluence можно просто поставить один YouTrack?!


              • убежал пробовать
                +2
                Добрый день, все верно! Сейчас как раз обновляем облачные сервера YouTrack — думаю, примерно в течение недели завершим процесс и у всех уже появится версия 2020.2 с базой знаний.
                А на случай, если у Вас еще нет YouTrack — облачный YouTrack теперь бесплатный для 10 пользователей.
                Надеемся, Вам понравится и будем рады обратной связи!
                0
                А что насчет кнопки «Перенести 100500 статей из конфлюенса»?
                  +2
                  Добрый день! Мы сейчас работаем над импортом из Confluence — планируем выпустить его к концу года, но сразу уточню, что сроки очень примерные и могут сдвинуться.
                    0

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

                  0

                  Насколько уникальны названия статей? В пределах папки? Проекта? Всего Ютрека?

                    0
                    Не уникальны, у статьи уникальный id, названия могут быть одинаковы в любом количестве.
                      0

                      Т.е. ЧПУ нет?

                        +1
                        Есть, мы реализовали его немного хитрее, там и id и название статьи.
                        Например так: HLP-A-3/Meeting-notes
                    0

                    Поймал одного из начальников отделов на таком.


                    1. Он пишет ТЗ на какую-то фичу. Ну не ТЗ конечно, а так… текст в свободной форме, он больше не умеет.
                    2. Разрабы ее прогают
                    3. Он ее тестит, затем изменяет свое тз и задает вопрос прогерам: а почему фича работает вот так?
                      Прогеры отвечают: а ты ж так просил же!
                      Он такой: а где? И с гордостью дает ссыль на измененное тз где уже все не так.

                    А можно ли запретить редактирование своих каментов? Вот как на хабре например.

                      0
                      У нас есть история изменения статей в базе знаний. Если он будет описывать задачу в тексте статьи, то Вы без проблем сможете ткнуть ему в то, что он ранее писал иначе :)
                        0

                        Странно, при чем здесь статьи в базе знаний, если речь идет о задачах в ютреке...

                          +1
                          Добрый день! Если ТЗ пишется в задаче в YouTrack, то все изменения описания задачи будут отражены во вкладке History. Бесследно ничего поправить нельзя, поэтому вы сможете увидеть, кто, когда и что изменил в описании ТЗ.

                          Возможно, ТЗ будет удобнее хранить именно в базе знаний. Вопрос с отслеживанием изменений там тоже решен — у каждой статьи есть история изменений, с diff, датой, временем и автором изменений. Поэтому точно так же, ни одно отдельное изменение не пройдет незамеченным.

                          Касательно запрета редактирования комментариев — это можно сделать, достаточно просто отобрать пермишен Update Comment, если речь идет о задачах, или пермишен Update Article Comment, если речь идет о статьях. Тогда пользователь не сможет редактировать комментарии.
                            0

                            Привет
                            History — имеется в виду "журнал задачи"? Это действительно работает для текста задачи, но не работает для комментариев.


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


                            Вопрос заключался в следующем: а можно ли запретить редактирование комментариев вовсе?
                            В разрешениях для роли Заявитель указано:


                            image
                            Но это не помогает.

                              +1
                              Вы все верно делаете. Это может не сработать, если пользователь получает разрешение на редактирование комментария откуда-то еще — например, состоит в группе, которой выдана роль с разрешением редактирования комментариев.
                              Чтобы проверить это, можно зайти на вкладку Настройки -> Пользователи -> <логин пользователя, которому надо запретить редактирование> -> Роли и вбить в строке поиска справа запрос «permission: {Обновление комментария к задаче}». Этот запрос покажет Вам все роли, через которые пользователь получает это разрешение, в каких проектах и откуда эти роли берутся — прямые ли это роли, или выданные командам/группам.
                              image
                              Чтобы запретить пользователю редактирование комментариев, нужно отключить разрешение «Обновление комментария к задаче» (и, наверное, имеет смысл отключить «Обновление чужого комментария к задаче») во всех ролях, выданных пользователю в нужном проекте.
                              Также напомню, что роли, выданные в проекте Global, применяются к каждому проекту.

                              Если не получится — пишите нам в саппорт, будем разбираться подробно, что пошло не так.
                      0
                      А ошибки в отображении Spent time уже починили? В одном из обновлений сломали, но уже долгое время пофиксить не могут.
                        0
                        Уточните, пожалуйста, о какой ошибке идет речь (как именно она проявляется)? Я проверю соответствующую задачу и отпишусь.
                          0
                          Речь идет вот об этом youtrack.jetbrains.com/issue/JT-55690 При просмотре Spent time визуальное форматирование скачет и пересекается, выглядит так себе.
                            +1
                            Спасибо. Эту задачу еще не починили, к сожалению, — передала Ваш комментарий разработчикам.
                              0
                              Только что починили:) фикс должен появиться в одном из ближайших багфикс апдейтов.
                                0
                                Большое спасибо!
                          0
                          Очень, очень не хватало этого! вплоть до того, что пришлось выделить на доске столбец «информация» и там закреплять задачи с нужными данными. Буду обновляться.
                          А как это все перекликается с продуктом Space? Это разные сущности или одно другое включает?
                            0
                            Это разные сущности :)
                            Наша база знаний больше заточена на интеграцию с Ютреком и его инфраструктурой. Например, в статье можно ссылаться на задачи, или даже вставлять урл на список задач, который развернется. В комментариях статей можно упоминать (mention) своих коллег и пр.
                            Права доступа, проекты, уведомления и все остальное тоже идет из Ютрека.
                            +1
                            Привет!

                            Вы запилили WYSIWYG-редактор в базе знаний и это отлично! И база и редактор. =)

                            Есть ли планы прикрутить WYSIWYG-редактор к задачам?

                            Да и кстати, сам ютрек стал работать заметно быстрее. За это отдельное спасибо!
                              +1
                              Привет, спасибо большое:) А за перформанс отдельное вам спасибо — мы целенаправленно над этим работали.
                              Да, планы есть, но, к сожалению, не очень близкие — сначала хотим выпустить helpdesk (там тоже будет WYSIWYG), а потом уже заняться внедрением WYSIWYG в задачи.
                              0

                              Отлично, а то я думал что эта фича будет эксклюзивом для Space.

                                0
                                Нет, не переживайте, мы продолжаем полноценно развивать YouTrack и будем добавлять туда все необходимые для этого фичи:)
                                0

                                Можно ли менять в базе знаний иерархию статей?

                                  0
                                  Конечно, можно перетаскивать статьи drag&drop по дереву, в т.ч. между проектами.
                                    0
                                    Добрый день! Статьи можно передвигать между ветками (и вниз по иерархии, и вверх, и в соседнюю ветку).
                                    Если вдруг я неправильно поняла Ваш вопрос — уточните, пожалуйста:)
                                    0
                                    Здравствуйте! Можно ли использовать хэштэги?
                                      0
                                      Здравствуйте, пока нет, тэги не поддерживаются. Но мы собираем фидбэк, какой функциональности не хватает — чтобы поддержать идею с тэгами, проголосуйте, пожалуйста, за реквест: youtrack.jetbrains.com/issue/JT-58189. Очень поможет, если опишете свой сценарий, в котором пригодятся тэги.

                                    Только полноправные пользователи могут оставлять комментарии. Войдите, пожалуйста.

                                    Самое читаемое