Hola a todos!
Mi nombre es Masha, trabajo como ingeniera de control de calidad en el grupo de empresas Tinkoff. El trabajo de control de calidad implica mucha comunicación con diferentes personas de diferentes equipos, y también fui gerente y conferencista de programas educativos, por lo que mi mapa de comunicación fue lo más amplio posible. Y en algún momento exploté: me di cuenta de que ya no puedo, no puedo, no puedo llenar toneladas infernales de tablas y documentos ilegibles.
Seguro que cada uno de vosotros ya os imagináis de lo que os hablo, y sudaréis frío: listas de apellidos sin orden alfabético, tablas con cientos de columnas con una disposición descuidada, tablas con miles de líneas en las que hay que borrar el dedo. en la rueda del mouse para buscar el encabezado, toneladas de páginas de instrucciones sin numerar, cientos de cartas enviadas entre sí con datos que deben analizarse y sistematizarse y meterse en las mismas tablas ilegibles.
Y así, cuando me calmé un poco, decidí escribir este artículo. Hablaré sobre cómo puede mantener normalmente (incluso a veces convenientemente) una variedad de documentación que no es del producto. Espero que el artículo se disperse por la red y que el nivel de infierno en los departamentos adyacentes al desarrollo baje al menos un poco, y que la gente (incluyéndome a mí) se vuelva un poco más feliz.
Instrumentos
La documentación del producto a menudo se guarda junto con el código, lo cual es bueno. Y la documentación que no es del producto generalmente se almacena en cualquier lugar. A menudo, las personas intentan traer información de diferentes lugares a Confluence, y nosotros no somos una excepción. Así que el resto de la historia es sobre él.
En general, Confluence es un motor wiki avanzado. Le permite trabajar con datos en diferentes tipos de visualización: texto con formato, tablas, varios gráficos. Esta es una herramienta muy interesante y poderosa, pero si no sabe cómo cocinarla, obtendrá otro volcado de documentos ilegibles. ¡Te enseñaré a cocinar!
macros
Casi toda la magia de Confluence se basa en macros. Hay muchas macros y se pueden combinar entre sí. Son pagos y gratuitos, además habrá varios ejemplos de macros con enlaces a documentación para ellos.
La interfaz para trabajar con macros es lo más simple posible. Para agregar una macro, debe hacer clic en el signo más y seleccionar el elemento deseado de la lista.
Si la macro es autosuficiente, es decir, no requiere la inserción de algo más dentro de sí misma, parece un bloque.
Si una macro necesita algo dentro para funcionar, parece una caja.
Al mismo tiempo, puedes poner tantos otros como quieras dentro de un marco, siempre que haya lógica en tu pirámide.
Cada macro tiene una vista previa: muestra inmediatamente si ha completado y configurado la macro correctamente.
Plantillas
Además de las macros, existe una herramienta conveniente para completar previamente el contenido: esta es una plantilla.
Las plantillas se pueden usar al crear cualquier página: simplemente haga clic en los tres puntos al lado del botón "Crear" y seleccione la plantilla deseada.
Luego, todo el contenido que está en la plantilla se agregará a la página creada.
Cualquiera puede crear páginas a partir de plantillas, pero solo aquellos que tienen los derechos para crear o editar plantillas pueden crear páginas. Puede agregar instrucciones adicionales a la plantilla sobre cómo se debe mantener la página.
Magia de mesa
En realidad, como aficionado a la tecnología, me encantan las tablas y puedo envolver casi cualquier información en ellas (aunque esto no siempre es efectivo). ¡Las tablas en sí son claras, estructuradas, escalables, mágicas!
Pero incluso una entidad tan maravillosa como una mesa puede estropearse. Y se puede utilizar con éxito e incluso mejorar. Más sobre eso a continuación.
Filtrado (complemento de pago)
Cualquier tabla grande e ilegible se puede hacer un poco menos grande y un poco más legible mediante el filtrado. Para hacer esto, puede usar una macro paga .
Dentro de esta macro, debe empujar una tabla (incluso la más fea es posible, lo principal es empujarla por completo). En la macro, puede seleccionar columnas para filtro desplegable, filtro de texto, numérico y filtro de fecha.
Imagínese que toda la información sobre los candidatos para todas las vacantes se registra en una lista tabular. Naturalmente, sin clasificar: las personas no acuden a las entrevistas en orden alfabético. Y debe comprender si ha entrevistado a un solicitante específico antes. Solo necesita poner este infierno en una macro de filtro, agregar un filtro de texto por apellido, y listo, la información está en su pantalla.
Vale la pena señalar que filtrar tablas enormes puede afectar el rendimiento del sistema y el tiempo de carga de la página, por lo que poner una tabla enorme en el filtro es una muleta temporal, es mejor construir un proceso en el que las personas no tengan que crear tablas enormes ilegibles (un ejemplo del proceso estará al final del artículo).
Clasificación (complemento de pago)
con magia macro también puede establecer la clasificación predeterminada en cualquier columna y numerar las filas. O haga clic en cualquier columna de la tabla colocada en la macro de filtro y se ordenará por esta columna.
Por ejemplo, tiene la misma tabla con los solicitantes y necesita averiguar cuántas entrevistas se realizaron en un mes determinado: ordene por fecha y regocíjese.
Tablas dinámicas (complemento de pago)
Ahora pasemos a un caso más interesante. Imagina que tu mesa es enorme y necesitas calcular algo sobre ella. Por supuesto, puede copiarlo a Excel, calcular lo que necesita y volver a cargar los datos en Confluence. ¿Se puede aplicar una macro una vez? y obtener el mismo resultado, solo actualizado.
Por ejemplo: tiene una tabla que contiene los datos de todos los empleados: dónde están ubicados geográficamente y qué puestos ocupan. Para calcular cuántas personas hay en cada ciudad, debe seleccionar en la macro "Tabla dinámica" la fila por la cual se agregan los datos (ubicación) y el tipo de operación (adición).
Naturalmente, puede agrupar según varios criterios a la vez, puede ver todas las posibilidades .
Gráficos (complemento de pago)
Como dije, no todos aman las mesas tanto como yo. Desafortunadamente, a la mayoría de los gerentes no les gustan en absoluto. Pero a todo el mundo le encantan las cartas de colores brillantes.
Los creadores de Confluence ciertamente lo sabían (seguro que también tienen jefes a los que les encantan los informes y gráficos, ¿dónde estarían sin ellos?). Por lo tanto, puedes usar la macro mágica . En esta macro, debe colocar la tabla dinámica del párrafo anterior y listo: sus aburridos datos grises se visualizan maravillosamente.
Naturalmente, esta macro también tiene configuraciones. Se puede encontrar un enlace a la documentación de cualquier macro en el modo de edición de esa macro.
Facilidad de agregación
La información de los párrafos anteriores probablemente no fue una revelación para ti. Pero ahora definitivamente sabes cómo usar macros, y puedo pasar a la parte más interesante del artículo.
Etiquetas
Es malo cuando las personas almacenan información en un artículo no estructurado o en una tabla enorme. Peor aún es cuando partes de esta información no solo son ilegibles, sino que también están dispersas por las extensiones de Confluence. Afortunadamente, es posible recopilar información dispersa en un solo lugar. Para esto necesitas usar (etiquetas conocidas por todos en las redes sociales).
Se puede agregar cualquier número de etiquetas a cualquier página. Al hacer clic en una etiqueta, accederá a una página de agregación con enlaces a todo el contenido con esa etiqueta, así como a un conjunto de etiquetas relacionadas. Las etiquetas relacionadas son aquellas que aparecen con frecuencia en la misma página.
Propiedades de la página
Puede agregar otra macro interesante a la página para estructurar información: . En su interior, debe enviar una tabla de dos columnas, la primera será la clave y la segunda será el valor de la propiedad. Además, la macro se puede ocultar de la página para que no interfiera con la lectura del contenido, pero la página seguirá estando marcada con las claves necesarias.
Preste atención a la ID: es conveniente configurarlo para colgar diferentes grupos de propiedades en diferentes páginas (o incluso diferentes grupos de propiedades en una página).
informes
Por etiquetas, puede recopilar informes. por ejemplo macro recopila todas las páginas con un determinado conjunto de etiquetas.
Pero un informe más interesante es una macro . También recopila todas las páginas con un determinado conjunto de etiquetas, pero no solo las enumera, sino que compila una tabla (¿captas la conexión con el comienzo del artículo?), En la que las columnas son las claves de las propiedades de la página.
Resulta una tabla resumen de información de diferentes fuentes. Es bueno que tenga características convenientes: diseño adaptable, clasificación por cualquier columna. Además, dicha tabla de informes se puede configurar dentro de la macro.
Al configurar, puede eliminar algunas columnas del informe, establecer el estado predeterminado o la cantidad de registros mostrados. También puede configurar el ID de propiedad de la página para ver solo la información que necesita.
Por ejemplo, tiene muchas páginas de empleados, estas páginas tienen un conjunto de propiedades sobre una persona: qué nivel tiene, dónde está, cuándo se unió al equipo, etc. Estas propiedades están marcadas id = empleado_inf. Y hay un segundo conjunto de propiedades en la misma página, que contiene información sobre una persona como parte de un equipo: qué rol desempeña la persona, en qué equipo está, etc. Estas propiedades están marcadas ID = equipo_inf. Luego, al compilar un informe, puede mostrar solo información para una identificación o dos a la vez, lo que sea más conveniente.
La belleza de este enfoque es que todos pueden recopilar la tabla de información que necesitan, que no duplicará nada y se actualizará cuando se actualice la página principal. Por ejemplo: a un líder de equipo no le importa cuándo sus desarrolladores consiguieron un trabajo, pero es importante qué papel juega cada uno de ellos en el equipo. El líder del equipo recogerá un informe sobre el equipo. Y al contador no le importa quién desempeña qué papel, pero los puestos son importantes: recopilará un informe sobre los puestos. En este caso, no se duplicará ni transferirá la fuente de información.
proceso final
instrucciones
Por lo tanto, podemos estructurar maravillosamente y agregar información de manera efectiva en Confluence usando macros como ejemplo. Pero idealmente, debe asegurarse de que la nueva información se estructure de inmediato y entre en todos los mecanismos de agregación que ya están en uso.
Aquí un montón de macros y plantillas vendrán al rescate. Para lograr que las personas creen nuevas páginas en el formato adecuado, puede utilizar la macro Crear a partir de plantilla. Agrega un botón a la página, al hacer clic en el cual se crea una nueva página a partir de la plantilla que necesita. De esta manera haces que la gente trabaje inmediatamente en el formato que necesitas.
En la plantilla desde la que permite crear una página, debe agregar etiquetas, la macro "Propiedades de la página" y una tabla de las propiedades que necesita de antemano. También recomiendo agregar instrucciones sobre con qué valores llenar la página y los valores de las propiedades.
Entonces el proceso final se verá así:
- Está creando una plantilla para un tipo específico de información.
- En esta plantilla, agregue etiquetas y propiedades de página en una macro.
- En cualquier lugar conveniente, cree una página raíz con un botón, haciendo clic en el cual se crea una página secundaria a partir de la plantilla.
- Inicie en la página raíz de los usuarios que potencialmente generarán la información necesaria (según la plantilla deseada, haciendo clic en el botón).
- Recopile un informe sobre las propiedades de la página a través de las etiquetas que especificó en la plantilla.
- Alégrate: tienes toda la información que necesitas en un formato conveniente.
Trampas
Como ingeniero de calidad, puedo decir con seguridad que no hay nada perfecto en el mundo. Incluso las mesas divinas son imperfectas. Y hay trampas en el proceso anterior.
- Si decide cambiar los nombres o la composición de las propiedades de la página, deberá actualizar todos los objetos ya creados para que sus datos se extraigan correctamente en el informe de resumen. Esto es triste, pero por otro lado, te obliga a pensar en detalle sobre la "arquitectura" de tu conjunto de información, lo cual es una tarea muy interesante.
- Tendrá que escribir una cantidad decente de instrucciones sobre cómo completar las tablas de información y usar las etiquetas. Pero, por otro lado, puede lanzar este artículo a todas las personas adecuadas.
Un ejemplo de almacenamiento de documentación que no es del producto
A través del proceso descrito anteriormente, puede organizar el almacenamiento de casi cualquier información. La belleza del enfoque es que es universal: una vez que los usuarios se acostumbran, dejan de hacer un lío. También una gran ventaja (pero no gratuita) es la capacidad de recopilar varias estadísticas sobre la marcha y dibujar hermosos diagramas en ellas.
Daré un ejemplo de nuestro proceso de mantenimiento de información sobre el equipo.
Para cada persona del equipo, decidimos crear una tarjeta de empleado. En consecuencia, tenemos una plantilla según la cual cada nueva persona crea esta tarjeta para sí mismo y guarda toda su información personal en ella.
Como puede ver, tenemos una tabla detallada de propiedades e inmediatamente tenemos instrucciones sobre cómo mantener esta página. Algunas de las etiquetas son colocadas por los propios empleados de acuerdo con las instrucciones, en la plantilla solo las principales: la etiqueta de la tarjeta tarjeta de empleado, etiqueta de dirección dirección-involucrar y etiqueta de comando equipo-qa.
Como resultado, después de que todos hayan creado una tarjeta para sí mismos, se obtiene una tabla completa con información sobre los empleados. Esta información se puede utilizar en diferentes puntos. Los administradores de recursos pueden recopilar tablas generales para ellos mismos y los líderes de equipo pueden recopilar tablas de comando agregando una etiqueta de equipo a la selección.
Por etiquetas, puede ver diferentes resúmenes, por ejemplo, por plan-de-actualización-qa se mostrarán todas las tareas para el desarrollo de control de calidad. Al mismo tiempo, cada persona en su tarjeta de empleado mantiene una historia importante y su propio plan de desarrollo: crea una página anidada a partir de la plantilla de planes de desarrollo.
Conclusión
¡Mantenga cualquier documentación de tal manera que no se avergüence de ella, y los usuarios no sufran un dolor insoportable!
Realmente espero que el artículo sea útil y que llegue el orden en toda la documentación del mundo.
Fuente: habr.com