🍧 🌈 🎾 YouTrack ahora con una base de conocimiento ⚜️ ✍🏾 👨🏽‍🍳

Hola Habr!

Equipo de Youtrack conectado de JetBrains. Nuestros usuarios nos han pedido durante mucho tiempo que inventemos algo que les permita almacenar documentación directamente en el rastreador. Y como parte del lanzamiento principal 2020.2, tuvo lugar un evento importante: apareció una base de conocimiento en YouTrack. Ahora puede recopilar información útil para trabajar en un solo lugar y almacenar documentación interna directamente en YouTrack, junto con proyectos y tareas, y sus usuarios externos podrán encontrar respuestas a sus preguntas directamente en el rastreador.

imagen

Para más detalles, bienvenido a la publicación.

¿Lo que es?

No inventamos una bicicleta: nuestra base de conocimiento es una colección de artículos. Los artículos se organizan en una estructura de árbol, cuya raíz es el proyecto: por lo tanto, cada proyecto puede tener una estructura de artículo ramificada.

imagen

Para aquellos a quienes les gusta la brevedad, enumeraré a continuación las principales características de la base de conocimiento, y para aquellos que estén interesados en mirar guiones e imágenes, bienvenidos.

Por lo tanto, además de crear artículos, puede:
1. Buscar el artículo deseado mediante la búsqueda de texto completo.
2. Utilice el editor WYSIWYG o Markdown.
3. Cree una variedad de contenido usando tablas, listas de verificación y listas ordenadas, así como adjuntando o incrustando varios medios, desde videos de YouTube hasta documentos de Google.
4. Discuta artículos en los comentarios, mencione colegas y tareas.
5. Suscríbase a las notificaciones de cambios y comentarios en artículos que le interesen.
6. Vea las versiones anteriores del artículo y, si es necesario, restaure cualquiera de las versiones anteriores.
7. Administre el acceso a los artículos utilizando roles (hemos agregado los permisos apropiados para controlar el acceso a los artículos a nivel de proyecto) y restringir la visibilidad de artículos individuales (o ramas de artículos completos) utilizando listas de visibilidad, al igual que para las tareas.

OK, y que hacer al respecto?

Según la experiencia de nuestros usuarios, existen dos de los escenarios más populares para usar una base de conocimiento: documentación interna del equipo (notas de reuniones, horarios de vacaciones, guías internas) y una base de conocimiento público para usuarios externos (preguntas frecuentes, documentación del producto, hojas de ruta).

La documentación interna de su equipo

Es difícil imaginar un equipo moderno sin ninguna documentación: notas de las reuniones, listas de verificación para los nuevos miembros del equipo o incluso instrucciones para configurar una VPN. La base de conocimientos de YouTrack ayudará a recopilar todo en un solo lugar y, por supuesto, será útil no solo para los equipos de desarrollo.
Digamos que organizas trabajo en equipo para colegas. Para planificar un evento, cree un artículo en la base de conocimiento y comience a escribir sus ideas allí. YouTrack guardará automáticamente el borrador y podrá volver a él en cualquier momento.

En el menú desplegable sobre el título del artículo, indique a quién serán visibles sus artículos. Puede restringir el acceso a documentos individuales y ramas en la jerarquía de artículos, al igual que cuando trabaja con tareas. De manera predeterminada, el artículo está disponible para todos los que tienen permiso para "leer el artículo" en el proyecto, pero puede reducir esta visibilidad en cualquier momento. La configuración de visibilidad se propaga por la jerarquía de la base de conocimiento, por lo que los artículos adjuntos serán visibles para las mismas personas que el artículo anterior.

imagen

Leer un texto completo no es muy fácil, y aquí las capacidades de nuestro editor vienen al rescate. Por ejemplo, recuerde a sus colegas cuán grandioso fue el trabajo en equipo el verano pasado adjuntando un video o estructurando su contenido usando tablas, listas de verificación y listas ordenadas.

Y después de la publicación del artículo, es hora de invitar a colegas a discutir su idea: el mecanismo de mención funciona de la misma manera que en las tareas. No se preocupe, no se perderá nada: las notificaciones se realizarán con comentarios. Si desea realizar un seguimiento de lo que está sucediendo en el artículo de otro autor, simplemente márquelo con un asterisco para recibir notificaciones al respecto también.

Una base de conocimiento abierta para sus usuarios.

En la base de conocimiento, es conveniente almacenar no solo documentación y hojas de ruta. Sus usuarios pueden tener preguntas sobre el uso de su producto. Recopilar respuestas a preguntas frecuentes y guías de uso en un solo lugar y ponerlas a disposición del público es una excelente manera de facilitarles la vida a los usuarios.

Primero permita el acceso anónimo.a su servidor YouTrack para que los usuarios externos puedan ingresar a la base de conocimiento sin registrarse. El control de acceso es muy flexible: puede abrir ramas de artículos separadas para un determinado círculo de personas: su equipo, usuarios registrados o para todos. ¡Ahora todo lo que tiene que hacer es llenar su base de conocimientos! Escriba artículos, agregue tablas, adjunte archivos y no tenga miedo de hacer ediciones: todas las versiones del artículo estarán disponibles en la pestaña de historial, y en cualquier momento podrá ver la diferencia entre las versiones y volver a cualquiera de los estados anteriores.

imagen

Responda las preguntas de los clientes en los comentarios a los artículos, reciba notificaciones de actualizaciones y enlace a artículos de la base de conocimiento en discusiones de tareas. Mencione a los colegas en los comentarios si se necesita su ayuda y publique enlaces a artículos y tareas relacionados: toda la información necesaria ya está a su alcance.

Buscar base de conocimiento

Tanto en bases de conocimiento abiertas como cerradas, funciona una búsqueda de texto completo, que encuentra todos los artículos que contienen la palabra o frase de búsqueda. Es fácil pasar de los resultados de búsqueda al artículo correcto para encontrar la respuesta a su pregunta.

imagen

¿Usas esto en JetBrains?

En el equipo de YouTrack tenemos una regla: siempre ejecutamos cualquier cambio significativo en el producto por nosotros mismos. La base de conocimientos no fue la excepción. Por ejemplo, hemos mantenido registros de nuestras reuniones semanales allí durante varios meses, y también hemos creado una sección completa de documentación interna: puede encontrar un plan de capacitación para nuevos ingenieros de soporte técnico, instrucciones para realizar trabajos programados en servidores en la nube y recomendaciones para irse de vacaciones.

imagen

Muchas de las funciones y correcciones se implementaron exactamente a raíz de nuestra experiencia: algo que parecía conveniente en los diseños resultó no ser muy cómodo de usar, o sentimos que faltaba alguna funcionalidad. Y la noche anterior al lanzamiento de los clásicos del género, encontramos un error bastante serio y lo arreglamos con esfuerzos conjuntos del equipo.

¿Hay algo más interesante?

Por supuesto, la base de conocimiento no es la única mejora en YouTrack 2020.2.

Los administradores del proyecto ahora pueden configurar un grupo de usuarios que verán las tareas en el proyecto de manera predeterminada; para este escenario, ya no necesita escribir código. Además, hemos ampliado la lista de tipos de campo que se pueden convertir a otros tipos: por ejemplo, un campo de texto se puede convertir en un campo de cadena y un campo de estado se puede convertir en uno enumerado para evitar un conflicto de varios campos de estado.

Para un trabajo productivo con colegas de otros equipos, puede compartir etiquetas, búsquedas guardadas, paneles e informes ágiles de una manera nueva y más flexible, es decir, compartir con varios grupos de usuarios a la vez.

También agregamos nuevas configuraciones para el espacio de trabajo y la lista de tareas, así como la acción "Clonar tarea como borrador". Para aquellos que recién comienzan a trabajar con tableros ágiles, hemos simplificado el proceso de crear un tablero lo más posible. Lea más sobre todas las innovaciones en nuestro blog .

YouTrack ahora con una base de conocimiento