🙇🏾 🔙 😑 YouTrack maintenant avec une base de connaissances 📲 👨🏽‍🔬 🏸

Bonjour, Habr!

Connected Youtrack Team de JetBrains. Nos utilisateurs nous demandent depuis longtemps de proposer quelque chose qui leur permettrait de stocker la documentation directement dans le tracker. Et dans le cadre de la version majeure 2020.2, un événement important a eu lieu: une base de connaissances est apparue dans YouTrack. Vous pouvez maintenant collecter des informations utiles pour travailler en un seul endroit et stocker la documentation interne directement dans YouTrack, côte à côte avec des projets et des tâches, et vos utilisateurs externes pourront trouver des réponses à leurs questions directement dans le tracker.

Pour plus de détails, bienvenue sur le post.

Ce que c'est?

Nous n'avons pas inventé un vélo: notre base de connaissances est une collection d'articles. Les articles sont organisés en une arborescence dont la racine est le projet: ainsi, chaque projet peut avoir une structure d'article ramifiée.

Pour ceux qui aiment la brièveté, je vais énumérer ci-dessous les principales caractéristiques de la base de connaissances, et pour ceux qui souhaitent regarder des scripts et des images, bienvenue.

Ainsi, en plus de créer des articles, vous pouvez:
1. Rechercher l'article souhaité à l'aide de la recherche en texte intégral.
2. Utilisez l'éditeur WYSIWYG ou Markdown.
3. Créez une variété de contenu à l'aide de tableaux, de listes de contrôle et de listes ordonnées, ainsi qu'en joignant ou en incorporant divers médias - des vidéos YouTube aux documents Google.
4. Discutez des articles dans les commentaires, mentionnez des collègues et des tâches.
5. Abonnez-vous aux notifications de modifications et de commentaires dans des articles qui vous intéressent.
6. Affichez les versions précédentes de l'article et, si nécessaire, restaurez l'une des versions précédentes.
7. Gérez l'accès aux articles à la fois à l'aide de rôles (nous avons ajouté les autorisations appropriées pour contrôler l'accès aux articles au niveau du projet) et restreignez la visibilité des articles individuels (ou des branches d'articles entières) à l'aide des listes de visibilité - tout comme pour les tâches.

OK, et que faire à ce sujet?

Selon l'expérience de nos utilisateurs, il existe deux des scénarios les plus populaires d'utilisation de la base de connaissances: la documentation interne de l'équipe (notes de réunion, horaires de vacances, guides internes) et une base de connaissances publique pour les utilisateurs externes (questions fréquemment posées, documentation produit, feuilles de route).

Documentation interne de votre équipe

Il est difficile d'imaginer une équipe moderne sans aucune documentation: notes de réunions, listes de contrôle pour les nouveaux membres de l'équipe, ou même instructions pour configurer un VPN. La base de connaissances YouTrack aidera à tout rassembler en un seul endroit et, bien sûr, elle sera utile non seulement pour les équipes de développement.
Disons que vous organisez le team building pour vos collègues. Pour planifier un événement, créez un article dans la base de connaissances et commencez à y écrire vos idées. YouTrack enregistre automatiquement le brouillon et vous pouvez y revenir à tout moment.

Dans le menu déroulant au-dessus du titre de l'article, indiquez à qui vos articles seront visibles. Vous pouvez restreindre l'accès à des documents et des branches individuels dans la hiérarchie d'articles - tout comme lorsque vous travaillez avec des tâches. Par défaut, l'article est disponible pour tous ceux qui ont l'autorisation de «lire l'article» dans le projet, mais vous pouvez restreindre cette visibilité à tout moment. Les paramètres de visibilité se propagent dans la hiérarchie de la base de connaissances, de sorte que les articles joints seront visibles aux mêmes personnes que l'article en amont.

La lecture d'un texte intégral n'est pas très facile - et ici les capacités de notre éditeur viennent à la rescousse. Par exemple, rappelez à vos collègues à quel point l'esprit d'équipe a été formidable l'été dernier en joignant une vidéo, ou structurez votre contenu à l'aide de tableaux, de listes de contrôle et de listes ordonnées.

Et après la publication de l'article, il est temps d'inviter des collègues à discuter de votre idée - le mécanisme de mention fonctionne de la même manière que dans les tâches. Ne vous inquiétez pas, vous ne manquerez de rien - des notifications viendront des commentaires. Si vous souhaitez suivre ce qui se passe dans l'article d'un autre auteur, marquez-le simplement avec un astérisque pour recevoir également des notifications à ce sujet.

Une base de connaissances ouverte pour vos utilisateurs

Dans la base de connaissances, il est pratique de stocker non seulement la documentation et les feuilles de route. Vos utilisateurs peuvent avoir des questions sur l'utilisation de votre produit. Rassembler les réponses aux questions fréquemment posées et les guides d'utilisation en un seul endroit et les rendre accessibles au public est un excellent moyen de faciliter la vie de vos utilisateurs.

Autorisez d'abord l' accès anonyme.sur votre serveur YouTrack afin que les utilisateurs externes puissent accéder à la base de connaissances sans s'inscrire. Le contrôle d'accès est très flexible - vous pouvez ouvrir des branches d'articles distinctes pour un certain cercle de personnes: votre équipe, les utilisateurs enregistrés ou pour tout le monde. Il ne vous reste plus qu'à remplir votre base de connaissances! Écrivez des articles, ajoutez des tableaux, joignez des fichiers et n'ayez pas peur de faire des modifications - toutes les versions de l'article seront disponibles sur l'onglet historique, et vous pouvez à tout moment voir la différence entre les versions et revenir à l'un des états précédents.

Répondez aux questions des clients dans les commentaires des articles, recevez des notifications de mises à jour et créez un lien vers les articles de la base de connaissances dans les discussions sur les tâches. Mentionnez vos collègues dans les commentaires si leur aide est requise et publiez des liens vers des articles et des tâches connexes - toutes les informations nécessaires sont déjà à portée de main.

Recherche dans la base de connaissances

Dans les bases de connaissances ouvertes et fermées, une recherche en texte intégral fonctionne, qui trouve tous les articles qui contiennent le mot ou l'expression de recherche. Il est facile de passer des résultats de recherche au bon article pour trouver la réponse à votre question.

L'utilisez-vous chez JetBrains?

Nous, dans l'équipe YouTrack, avons une règle: nous appliquons toujours nous-mêmes tout changement important dans le produit. La base de connaissances ne fait pas exception. Par exemple, nous y conservons des enregistrements de nos réunions hebdomadaires depuis plusieurs mois, et nous avons également créé toute une section de documentation interne: vous pouvez trouver un plan de formation pour les nouveaux ingénieurs du support technique, des instructions pour effectuer des travaux planifiés sur des serveurs cloud et des recommandations pour partir en vacances.

De nombreuses fonctionnalités et corrections ont été mises en œuvre exactement à la suite de notre expérience: quelque chose qui semblait pratique sur les mises en page s'est avéré peu confortable à utiliser, ou nous avons senti que certaines fonctionnalités manquaient. Et la veille de la sortie des classiques du genre, nous avons trouvé un bug assez sérieux et avons réussi à le corriger grâce aux efforts conjoints de l'équipe.

Y a-t-il autre chose d'intéressant?

Bien sûr, la base de connaissances n'est pas la seule amélioration de YouTrack 2020.2.

Les administrateurs de projet peuvent désormais configurer un groupe d'utilisateurs qui verront les tâches dans le projet par défaut - pour ce scénario, vous n'avez plus besoin d'écrire du code. De plus, nous avons élargi la liste des types de champs qui peuvent être convertis en d'autres types: par exemple, un champ de texte peut être converti en champ de chaîne et un champ d'état peut être converti en un champ énuméré pour éviter un conflit entre plusieurs champs d'état.

Pour un travail productif avec des collègues d'autres équipes, vous pouvez partager des balises, des recherches enregistrées, des tableaux de bord Agile et des rapports d'une manière nouvelle et plus flexible, à savoir partager avec plusieurs groupes d'utilisateurs à la fois.

Nous avons également ajouté de nouveaux paramètres pour l'espace de travail et la liste des tâches, ainsi que l'action «Cloner la tâche en tant que brouillon». Pour ceux qui commencent tout juste à travailler avec des cartes Agile, nous avons simplifié le processus de création d'une carte autant que possible. En savoir plus sur toutes les innovations dans notre blog .

YouTrack maintenant avec une base de connaissances