Привет, Хабр!
На связи команда Youtrack из JetBrains. Наши пользователи очень давно просили нас придумать что-то, что позволило бы им хранить документацию прямо в трекере. И вот в рамках мажорного релиза 2020.2 произошло важное событие: в YouTrack появилась база знаний. Теперь вы можете собирать полезную информацию для работы в одном месте и хранить внутреннюю документацию прямо в YouTrack, бок о бок с проектами и задачами, а ваши внешние пользователи смогут находить ответы на свои вопросы прямо в трекере.
За подробностями добро пожаловать в пост.
Мы не стали изобретать велосипед: наша база знаний — это набор статей. Статьи организуются в древовидную структуру, корнем которой является проект: таким образом, у каждого проекта может быть разветвленная структура статей.
Для тех, кто любит краткость, ниже перечислю основные возможности базы знаний, а тем, кому интересно посмотреть на сценарии и картинки, — добро пожаловать дальше.
Итак, помимо собственно создания статей, вы сможете:
1. Искать нужные статьи с помощью полнотекстового поиска.
2. Использовать WYSIWYG или Markdown-редактор.
3. Создавать разнообразный контент, используя таблицы, чек-листы и упорядоченные списки, а также прикрепляя или встраивая различные медиа — от YouTube-видео до Google-документов.
4. Обсуждать статьи в комментариях, упоминать коллег и задачи.
5. Подписываться на уведомления об изменениях и комментариях в интересных вам статьях.
6. Просматривать предыдущие версии статьи и при необходимости восстанавливать любую из предыдущих версий.
7. Управлять доступом к статьям как с помощью ролей (мы добавили соответствующие разрешения для управления доступом к статьям на проектном уровне), так и ограничивать видимость отдельных статей (или целых ветвей статей) с помощью списков видимости — точно так же, как для задач.
Хорошо, и что с этим делать?
По опыту наших пользователей, есть два самых популярных сценария использования базы знаний: внутренняя документация команды (заметки со встреч, расписания отпусков, внутренние гайды) и публичная база знаний для внешних пользователей (часто задаваемые вопросы, продуктовая документация, роадмапы).
Сложно представить современную команду совсем без документации: заметки с совещаний, чек-листы для новых членов команды или даже инструкция по настройке VPN. База знаний YouTrack поможет собрать все в одном месте, и, конечно, это будет полезно не только для команд разработчиков.
Допустим, вы организуете тимбилдинг для коллег. Чтобы спланировать мероприятие, создайте статью в базе знаний и начните записывать туда свои идеи. YouTrack автоматически сохранит черновик, и вы сможете вернуться к нему в любое время.
В выпадающем меню над заголовком статьи укажите, кому будут видны ваши статьи. Вы можете ограничить доступ к отдельным документам и веткам в иерархии статей — так же, как при работе с задачами. По умолчанию статья доступна всем, у кого есть разрешение «чтение статьи» в проекте, но вы можете сузить эту видимость в любое время. Настройки видимости распространяются вниз по иерархии базы знаний, поэтому вложенные статьи будут видны тем же людям, что и вышестоящая статья.
Читать сплошной текст не очень легко — и тут на помощь приходят возможности нашего редактора. Например, напомните коллегам, как здорово прошел тимбилдинг прошлым летом, прикрепив видео, или структурируйте контент с помощью таблиц, чек-листов и упорядоченных списков.
А после публикации статьи самое время пригласить коллег обсудить вашу идею — механизм упоминаний работает так же, как в задачах. Не переживайте, вы ничего не пропустите — о комментариях будут приходить уведомления. Если вы хотите следить за тем, что происходит в статье другого автора, просто отметьте ее звездочкой, чтобы получать уведомления и о ней тоже.
В базе знаний удобно хранить не только документацию и роадмапы. У ваших пользователей могут возникать вопросы по использованию вашего продукта. Собрать ответы на часто задаваемые вопросы и руководства по использованию в одном месте и открыть их для публичного доступа — отличный способ облегчить жизнь вашим пользователям.
Прежде всего разрешите анонимный доступ к вашему серверу YouTrack, чтобы внешние пользователи могли заходить в базу знаний без регистрации. Управление доступом очень гибкое — вы сможете открыть отдельные ветви статей для определенного круга людей: вашей команды, зарегистрированных пользователей или для всех желающих. Теперь осталось только наполнить вашу базу знаний! Пишите статьи, добавляйте таблицы, прикрепляйте файлы и не бойтесь вносить правки — все версии статьи будут доступны на вкладке истории, и вы в любой момент сможете просмотреть разницу между версиями и откатиться к любому из предыдущих состояний.
Отвечайте на вопросы клиентов в комментариях к статьям, получайте уведомления об обновлениях и ссылайтесь на статьи из базы знаний в обсуждениях задач. Упоминайте коллег в комментариях, если требуется их помощь, и размещайте ссылки на связанные статьи и задачи — вся нужная информация уже у вас под рукой.
И в открытых, и в закрытых базах знаний работает полнотекстовый поиск, который находит все статьи, содержащие искомое слово или словосочетание. От результатов поиска легко перейти к нужной статье, чтобы найти ответ на свой вопрос.
У нас в команде YouTrack есть правило: любое существенное изменение в продукте мы всегда обкатываем на себе. База знаний не стала исключением. Например, мы уже несколько месяцев ведем там записи наших еженедельных совещаний, а еще создали целый раздел внутренней документации: в нем можно найти план обучения новых инженеров технической поддержки, инструкции по проведению плановых работ на облачных серверах и рекомендации по уходу в отпуск.
Многие фичи и исправления были реализованы именно по следам нашего опыта: что-то, что выглядело удобным на макетах, оказалось не очень комфортным в использовании, или мы чувствовали, что какой-то функциональности не хватает. А в ночь перед релизом по классике жанра мы нашли достаточно серьезный баг и совместными командными усилиями успели его починить.
А еще что-то интересное есть?
Конечно, база знаний — это не единственное улучшение в YouTrack 2020.2.
Администраторы проектов теперь могут установить группу пользователей, которым по умолчанию будут видны задачи в проекте, — для этого сценария больше не нужно писать код. Кроме того, мы расширили список типов полей, которые можно конвертировать в другие типы: например, текстовое поле можно превратить в строковое, а поле состояния — в перечисляемое, чтобы избежать конфликта нескольких полей состояния.
Для продуктивной работы с коллегами из других команд вы можете делиться тегами, сохраненными поисками, Agile-досками и отчетами новым, более гибким способом, а именно поделиться сразу с несколькими группами пользователей.
А еще мы добавили новые настройки рабочей области и списка задач, а также действие «Клонировать задачу как черновик». Для тех, кто только начинает работать с Agile-досками, мы максимально упростили процесс создания доски. Подробнее обо всех нововведениях читайте в нашем блоге.
На связи команда Youtrack из JetBrains. Наши пользователи очень давно просили нас придумать что-то, что позволило бы им хранить документацию прямо в трекере. И вот в рамках мажорного релиза 2020.2 произошло важное событие: в YouTrack появилась база знаний. Теперь вы можете собирать полезную информацию для работы в одном месте и хранить внутреннюю документацию прямо в YouTrack, бок о бок с проектами и задачами, а ваши внешние пользователи смогут находить ответы на свои вопросы прямо в трекере.
За подробностями добро пожаловать в пост.
Что это такое?
Мы не стали изобретать велосипед: наша база знаний — это набор статей. Статьи организуются в древовидную структуру, корнем которой является проект: таким образом, у каждого проекта может быть разветвленная структура статей.
Для тех, кто любит краткость, ниже перечислю основные возможности базы знаний, а тем, кому интересно посмотреть на сценарии и картинки, — добро пожаловать дальше.
Итак, помимо собственно создания статей, вы сможете:
1. Искать нужные статьи с помощью полнотекстового поиска.
2. Использовать WYSIWYG или Markdown-редактор.
3. Создавать разнообразный контент, используя таблицы, чек-листы и упорядоченные списки, а также прикрепляя или встраивая различные медиа — от YouTube-видео до Google-документов.
4. Обсуждать статьи в комментариях, упоминать коллег и задачи.
5. Подписываться на уведомления об изменениях и комментариях в интересных вам статьях.
6. Просматривать предыдущие версии статьи и при необходимости восстанавливать любую из предыдущих версий.
7. Управлять доступом к статьям как с помощью ролей (мы добавили соответствующие разрешения для управления доступом к статьям на проектном уровне), так и ограничивать видимость отдельных статей (или целых ветвей статей) с помощью списков видимости — точно так же, как для задач.
Хорошо, и что с этим делать?
По опыту наших пользователей, есть два самых популярных сценария использования базы знаний: внутренняя документация команды (заметки со встреч, расписания отпусков, внутренние гайды) и публичная база знаний для внешних пользователей (часто задаваемые вопросы, продуктовая документация, роадмапы).
Внутренняя документация вашей команды
Сложно представить современную команду совсем без документации: заметки с совещаний, чек-листы для новых членов команды или даже инструкция по настройке VPN. База знаний YouTrack поможет собрать все в одном месте, и, конечно, это будет полезно не только для команд разработчиков.
Допустим, вы организуете тимбилдинг для коллег. Чтобы спланировать мероприятие, создайте статью в базе знаний и начните записывать туда свои идеи. YouTrack автоматически сохранит черновик, и вы сможете вернуться к нему в любое время.
В выпадающем меню над заголовком статьи укажите, кому будут видны ваши статьи. Вы можете ограничить доступ к отдельным документам и веткам в иерархии статей — так же, как при работе с задачами. По умолчанию статья доступна всем, у кого есть разрешение «чтение статьи» в проекте, но вы можете сузить эту видимость в любое время. Настройки видимости распространяются вниз по иерархии базы знаний, поэтому вложенные статьи будут видны тем же людям, что и вышестоящая статья.
Читать сплошной текст не очень легко — и тут на помощь приходят возможности нашего редактора. Например, напомните коллегам, как здорово прошел тимбилдинг прошлым летом, прикрепив видео, или структурируйте контент с помощью таблиц, чек-листов и упорядоченных списков.
А после публикации статьи самое время пригласить коллег обсудить вашу идею — механизм упоминаний работает так же, как в задачах. Не переживайте, вы ничего не пропустите — о комментариях будут приходить уведомления. Если вы хотите следить за тем, что происходит в статье другого автора, просто отметьте ее звездочкой, чтобы получать уведомления и о ней тоже.
Открытая база знаний для ваших пользователей
В базе знаний удобно хранить не только документацию и роадмапы. У ваших пользователей могут возникать вопросы по использованию вашего продукта. Собрать ответы на часто задаваемые вопросы и руководства по использованию в одном месте и открыть их для публичного доступа — отличный способ облегчить жизнь вашим пользователям.
Прежде всего разрешите анонимный доступ к вашему серверу YouTrack, чтобы внешние пользователи могли заходить в базу знаний без регистрации. Управление доступом очень гибкое — вы сможете открыть отдельные ветви статей для определенного круга людей: вашей команды, зарегистрированных пользователей или для всех желающих. Теперь осталось только наполнить вашу базу знаний! Пишите статьи, добавляйте таблицы, прикрепляйте файлы и не бойтесь вносить правки — все версии статьи будут доступны на вкладке истории, и вы в любой момент сможете просмотреть разницу между версиями и откатиться к любому из предыдущих состояний.
Отвечайте на вопросы клиентов в комментариях к статьям, получайте уведомления об обновлениях и ссылайтесь на статьи из базы знаний в обсуждениях задач. Упоминайте коллег в комментариях, если требуется их помощь, и размещайте ссылки на связанные статьи и задачи — вся нужная информация уже у вас под рукой.
Поиск по базе знаний
И в открытых, и в закрытых базах знаний работает полнотекстовый поиск, который находит все статьи, содержащие искомое слово или словосочетание. От результатов поиска легко перейти к нужной статье, чтобы найти ответ на свой вопрос.
А сами вы в JetBrains этим пользуетесь?
У нас в команде YouTrack есть правило: любое существенное изменение в продукте мы всегда обкатываем на себе. База знаний не стала исключением. Например, мы уже несколько месяцев ведем там записи наших еженедельных совещаний, а еще создали целый раздел внутренней документации: в нем можно найти план обучения новых инженеров технической поддержки, инструкции по проведению плановых работ на облачных серверах и рекомендации по уходу в отпуск.
Многие фичи и исправления были реализованы именно по следам нашего опыта: что-то, что выглядело удобным на макетах, оказалось не очень комфортным в использовании, или мы чувствовали, что какой-то функциональности не хватает. А в ночь перед релизом по классике жанра мы нашли достаточно серьезный баг и совместными командными усилиями успели его починить.
А еще что-то интересное есть?
Конечно, база знаний — это не единственное улучшение в YouTrack 2020.2.
Администраторы проектов теперь могут установить группу пользователей, которым по умолчанию будут видны задачи в проекте, — для этого сценария больше не нужно писать код. Кроме того, мы расширили список типов полей, которые можно конвертировать в другие типы: например, текстовое поле можно превратить в строковое, а поле состояния — в перечисляемое, чтобы избежать конфликта нескольких полей состояния.
Для продуктивной работы с коллегами из других команд вы можете делиться тегами, сохраненными поисками, Agile-досками и отчетами новым, более гибким способом, а именно поделиться сразу с несколькими группами пользователей.
А еще мы добавили новые настройки рабочей области и списка задач, а также действие «Клонировать задачу как черновик». Для тех, кто только начинает работать с Agile-досками, мы максимально упростили процесс создания доски. Подробнее обо всех нововведениях читайте в нашем блоге.
