🙇🏽 🆕 🧖🏼 YouTrack agora com uma base de conhecimento 🔚 👨 👩🏼‍🤝‍👨🏾

Olá Habr!

Equipe do Youtrack conectada do JetBrains. Nossos usuários há muito tempo nos pedem para criar algo que lhes permita armazenar a documentação diretamente no rastreador. E como parte do grande lançamento 2020.2, ocorreu um evento importante: uma base de conhecimento apareceu no YouTrack. Agora você pode coletar informações úteis para trabalhar em um único local e armazenar documentação interna diretamente no YouTrack, lado a lado com projetos e tarefas, e seus usuários externos poderão encontrar respostas para suas perguntas diretamente no rastreador.

imagem

Para detalhes, bem-vindo ao post.

O que é isso?

Não inventamos uma bicicleta: nossa base de conhecimento é uma coleção de artigos. Os artigos são organizados em uma estrutura em árvore, cuja raiz é o projeto: assim, cada projeto pode ter uma estrutura de artigo ramificada.

imagem

Para quem gosta de concisão, listarei abaixo os principais recursos da base de conhecimento e para aqueles que estão interessados em ver scripts e fotos, sejam bem-vindos.

Portanto, além de realmente criar artigos, você pode:
1. Pesquise o artigo desejado usando a pesquisa de texto completo.
2. Use o editor WYSIWYG ou Markdown.
3. Crie uma variedade de conteúdo usando tabelas, listas de verificação e listas ordenadas, além de anexar ou incorporar várias mídias - de vídeos do YouTube a documentos do Google.
4. Discuta artigos nos comentários, mencione colegas e tarefas.
5. Assine as notificações de alterações e comentários em artigos interessantes para você.
6. Visualize as versões anteriores do artigo e, se necessário, restaure qualquer uma das versões anteriores.
7. Gerencie o acesso a artigos usando funções (adicionamos permissões apropriadas para controlar o acesso a artigos no nível do projeto) e restrinja a visibilidade de artigos individuais (ou ramificações inteiras de artigos) usando listas de visibilidade - assim como para tarefas.

OK, e o que fazer sobre isso?

De acordo com a experiência de nossos usuários, existem dois dos cenários mais populares para o uso de uma base de conhecimento: documentação interna da equipe (notas de reuniões, agendas de férias, guias internos) e uma base pública de conhecimento para usuários externos (perguntas frequentes, documentação do produto, roteiros).

Documentação interna da sua equipe

É difícil imaginar uma equipe moderna sem nenhuma documentação: notas de reuniões, listas de verificação para novos membros da equipe ou até instruções para configurar uma VPN. A base de conhecimentos do YouTrack ajudará a coletar tudo em um só lugar e, é claro, será útil não apenas para as equipes de desenvolvimento.
Digamos que você organize a formação de equipes para colegas. Para planejar um evento, crie um artigo na base de conhecimento e comece a escrever suas idéias lá. O YouTrack salvará automaticamente o rascunho e você poderá retornar a ele a qualquer momento.

No menu suspenso acima do título do artigo, indique para quem seus artigos estarão visíveis. Você pode restringir o acesso a documentos e ramificações individuais na hierarquia de artigos - assim como ao trabalhar com tarefas. Por padrão, o artigo está disponível para todos que têm permissão para "ler o artigo" no projeto, mas você pode restringir essa visibilidade a qualquer momento. As configurações de visibilidade são propagadas pela hierarquia da base de conhecimento; portanto, os artigos anexados serão visíveis para as mesmas pessoas que o artigo upstream.

imagem

Ler um texto completo não é muito fácil - e aqui os recursos de nosso editor são úteis. Por exemplo, lembre seus colegas de quão grande foi a formação de equipes no verão passado, anexando um vídeo ou estruture seu conteúdo usando tabelas, listas de verificação e listas ordenadas.

E após a publicação do artigo, é hora de convidar colegas para discutir sua ideia - o mecanismo de menção funciona da mesma maneira que nas tarefas. Não se preocupe, você não perderá nada - as notificações surgirão sobre comentários. Se você deseja acompanhar o que está acontecendo no artigo de outro autor, basta marcá-lo com um asterisco para receber notificações sobre ele também.

Uma base de conhecimento aberta para seus usuários

Na base de conhecimento, é conveniente armazenar não apenas documentação e roteiros. Seus usuários podem ter dúvidas sobre o uso do seu produto. Reunir respostas para perguntas frequentes e guias de uso em um só lugar e disponibilizá-las ao público é uma ótima maneira de facilitar a vida dos usuários.

Primeiro permita o acesso anônimo.no servidor do YouTrack para que usuários externos possam entrar na base de conhecimento sem se registrar. O controle de acesso é muito flexível - você pode abrir ramificações de artigos separadas para um determinado círculo de pessoas: sua equipe, usuários registrados ou para todos. Agora tudo o que você precisa fazer é preencher sua base de conhecimento! Escreva artigos, adicione tabelas, anexe arquivos e não tenha medo de fazer edições - todas as versões do artigo estarão disponíveis na guia histórico e você poderá a qualquer momento ver a diferença entre as versões e reverter para qualquer um dos estados anteriores.

imagem

Responda às perguntas dos clientes nos comentários dos artigos, receba notificações de atualizações e vincule-os aos artigos da base de conhecimento nas discussões de tarefas. Mencione os colegas nos comentários, se a ajuda deles for necessária, e poste links para artigos e tarefas relacionados - todas as informações necessárias já estão ao seu alcance.

Pesquisa da Base de Conhecimento

Tanto em bases de conhecimento abertas quanto fechadas, funciona uma pesquisa de texto completo, que encontra todos os artigos que contêm a palavra ou frase de pesquisa. É fácil passar dos resultados da pesquisa para o artigo certo para encontrar a resposta para sua pergunta.

imagem

Você usa isso no JetBrains?

Nós da equipe do YouTrack temos uma regra: sempre executamos qualquer alteração significativa no produto por nós mesmos. A base de conhecimento não foi exceção. Por exemplo, mantemos registros de nossas reuniões semanais por vários meses e também criamos uma seção inteira da documentação interna: você pode encontrar um plano de treinamento para novos engenheiros de suporte técnico, instruções para realizar trabalhos agendados em servidores em nuvem e recomendações para sair de férias.

imagem

Muitos recursos e correções foram implementados exatamente na sequência de nossa experiência: algo que parecia conveniente nos layouts não era muito confortável de usar, ou achamos que faltava alguma funcionalidade. E na noite anterior ao lançamento dos clássicos do gênero, encontramos um bug bastante sério e conseguimos consertá-lo com esforços conjuntos da equipe.

Existe algo mais interessante?

Obviamente, a base de conhecimento não é a única melhoria no YouTrack 2020.2.

Agora, os administradores do projeto podem configurar um grupo de usuários que verão tarefas no projeto por padrão - nesse cenário, você não precisa mais escrever código. Além disso, expandimos a lista de tipos de campos que podem ser convertidos para outros tipos: por exemplo, um campo de texto pode ser convertido em um campo de sequência e um campo de status pode ser convertido em um campo enumerado para evitar conflitos de vários campos de status.

Para um trabalho produtivo com colegas de outras equipes, você pode compartilhar tags, pesquisas salvas, quadros ágeis e relatórios de uma maneira nova e mais flexível, ou seja, compartilhar com vários grupos de usuários ao mesmo tempo.

Também adicionamos novas configurações para o espaço de trabalho e a lista de tarefas, bem como a ação "Clonar tarefa como rascunho". Para aqueles que estão começando a trabalhar com placas Agile, simplificamos o processo de criação de placas o máximo possível. Leia mais sobre todas as inovações em nosso blog .

YouTrack agora com uma base de conhecimento