{"id":76463,"date":"2020-04-02T13:42:40","date_gmt":"2020-04-02T11:42:40","guid":{"rendered":"https:\/\/prohoster.info\/blog\/administrirovanie\/proektirovanie-v-confluence"},"modified":"2020-04-02T13:42:40","modified_gmt":"2020-04-02T11:42:40","slug":"proektirovanie-v-confluence","status":"publish","type":"post","link":"https:\/\/prohoster.info\/es\/blog\/administrirovanie\/proektirovanie-v-confluence","title":{"rendered":"Dise\u00f1o en Confluence","gt_translate_keys":[{"key":"rendered","format":"text"}]},"content":{"rendered":"

\u00a1Hola a todos! <\/p>\n

Me llamo Masha, soy ingeniera de control de calidad en el grupo de empresas Tinkoff. El trabajo en QA implica muchas comunicaciones con diferentes personas de varios equipos, y adem\u00e1s, he sido gerente y conferenciante de programas educativos, por lo que mi mapa de comunicaciones era lo m\u00e1s amplio posible. Y en alg\u00fan momento, explot\u00e9: comprend\u00ed que ya no pod\u00eda m\u00e1s, no pod\u00eda m\u00e1s con las toneladas infernales de tablas y documentos ilegibles. <\/p>\n

\"Dise\u00f1o
\n
\n<\/a><\/noindex>
\nSeguramente cada uno de ustedes se ha imaginado ahora lo que estoy diciendo y ha sudado fr\u00edo: listas de apellidos sin orden alfab\u00e9tico, tablas con cientos de columnas con un formato desordenado, tablas con miles de filas en las que hay que hacer girar el dedo en el mouse para ver los encabezados, toneladas de p\u00e1ginas de instrucciones no numeradas, cientos de correos enviados entre s\u00ed con datos que hay que analizar y sistematizar y encajar en las mismas tablas ilegibles.<\/p>\n

\"Dise\u00f1o
\n
\nY as\u00ed, cuando me calm\u00e9 un poco, decid\u00ed escribir este art\u00edculo. Hablar\u00e9 sobre c\u00f3mo llevar una documentaci\u00f3n no productiva de manera adecuada (incluso a veces conveniente). Espero que el art\u00edculo se difunda por la red y el nivel de caos en los departamentos cercanos al desarrollo, aunque sea un poco, disminuya, y la gente (yo incluida) sea un poco m\u00e1s feliz.<\/p>\n

\"Dise\u00f1o
\n<\/p>\n

Herramientas<\/h2>\n

\nLa documentaci\u00f3n de productos a menudo se guarda junto con el c\u00f3digo, y eso es bueno. Pero la documentaci\u00f3n no productiva suele guardarse en cualquier lugar. A menudo, la gente intenta transferir informaci\u00f3n de diferentes lugares a Confluence, y nosotros no somos una excepci\u00f3n. As\u00ed que aqu\u00ed est\u00e1 la historia sobre ello.<\/p>\n

En general, Confluence es un motor wiki avanzado. Permite trabajar con datos en diferentes formas de visualizaci\u00f3n: texto con formato, tablas, diversos gr\u00e1ficos. Es una herramienta muy interesante y potente, pero si no sabes c\u00f3mo prepararla, obtendr\u00e1s un basurero m\u00e1s de documentos ilegibles. \u00a1Te ense\u00f1ar\u00e9 a prepararlo!<\/p>\n

\"Dise\u00f1o
\n<\/p>\n

Macros<\/h2>\n

\nCasi toda la magia de Confluence se basa en macros. Hay muchas macros, y se pueden combinar entre s\u00ed. Algunas son de pago y otras gratuitas, m\u00e1s adelante habr\u00e1 diferentes ejemplos de macros con enlaces a la documentaci\u00f3n correspondiente.<\/p>\n

La interfaz para trabajar con macros es muy sencilla. Para agregar un macro, debes hacer clic en el m\u00e1s y seleccionar el elemento deseado de la lista.<\/p>\n

\"Dise\u00f1o
\n
\nSi el macro es autosuficiente, es decir, no requiere la inserci\u00f3n de nada m\u00e1s dentro de s\u00ed mismo, se ver\u00e1 como un bloque.<\/p>\n

\"Dise\u00f1o
\n
\nSi se necesita colocar algo dentro del macro para que funcione, se ver\u00e1 como un marco.<\/p>\n

\"Dise\u00f1o
\n
\nDentro de un marco se pueden colocar tantas otras cosas como se desee, siempre que haya l\u00f3gica en tu pir\u00e1mide.<\/p>\n

\"Dise\u00f1o
\n
\nCada macro tiene una vista previa: se puede ver de inmediato si has completado y configurado el macro correctamente.<\/p>\n

Plantillas<\/h2>\n

\nAdem\u00e1s de los macros, hay una herramienta conveniente de autocompletado de contenido: la plantilla.
\nSe pueden utilizar plantillas al crear cualquier p\u00e1gina: simplemente haz clic en los tres puntos junto al bot\u00f3n 'Crear' y selecciona la plantilla deseada.<\/p>\n

\"Dise\u00f1o
\n
\nEntonces, toda la informaci\u00f3n de la plantilla se a\u00f1adir\u00e1 a la p\u00e1gina creada.<\/p>\n

Cualquiera puede crear p\u00e1ginas a partir de plantillas, pero solo quienes tienen permisos pueden crear o editar las plantillas. En la plantilla se pueden a\u00f1adir instrucciones adicionales sobre c\u00f3mo debe llevarse la p\u00e1gina.<\/p>\n

\"Dise\u00f1o
\n<\/p>\n

La magia de las tablas<\/h2>\n

\nDe hecho, como t\u00e9cnico, amo tiernamente las tablas y puedo empaquetar casi cualquier informaci\u00f3n en ellas (aunque no siempre sea eficiente). Las tablas son claras, estructuradas, escalables, \u00a1m\u00e1gicas!<\/p>\n

\"Dise\u00f1o
\n
\nPero incluso una entidad tan maravillosa como la tabla puede arruinarse. No obstante, tambi\u00e9n se puede utilizar adecuadamente e incluso mejorar. De eso hablaremos a continuaci\u00f3n.<\/p>\n

Filtraci\u00f3n (plugin de pago)<\/h3>\n

\nCualquier tabla enorme y poco legible puede hacerse un poco menos enorme y un poco m\u00e1s legible mediante filtraci\u00f3n. Para ello se puede usar un macro de pago. \u2018Filtro de tablas\u2019<\/a><\/noindex>.<\/p>\n

Dentro de este macro se debe colocar la tabla (incluso la m\u00e1s fea, lo importante es introducirla completamente). En el macro se pueden seleccionar columnas para filtrar desde un men\u00fa desplegable, un filtro de texto, num\u00e9rico y un filtro por fechas. <\/p>\n

\"Dise\u00f1o
\n
\nImagina que toda la informaci\u00f3n sobre los candidatos para todos los puestos se registra en una lista tabular. Naturalmente, no estar\u00e1 ordenada, ya que las personas no llegan a las entrevistas en orden alfab\u00e9tico. Y necesitas saber si has entrevistado a un determinado solicitante antes. Simplemente debes introducir ese caos en el macro de filtraci\u00f3n, a\u00f1adir un filtro de texto por apellido, \u00a1y voil\u00e0, la informaci\u00f3n est\u00e1 en tu pantalla!<\/p>\n

\"Dise\u00f1o
\n
\nEs importante mencionar que filtrar tablas enormes puede afectar el rendimiento del sistema y el tiempo de carga de las p\u00e1ginas, por lo que meter una tabla enorme en un filtro es una soluci\u00f3n temporal; lo mejor es establecer un proceso en el que las personas no tengan que crear tablas enormes e ilegibles (un ejemplo de proceso se dar\u00e1 al final del art\u00edculo).<\/p>\n

Clasificaci\u00f3n (plugin de pago)<\/h3>\n

\nCon la ayuda de un macro m\u00e1gico \u2018Filtro de tablas\u2019<\/a><\/noindex> tambi\u00e9n se puede establecer una clasificaci\u00f3n por defecto para cualquier columna y numerar las filas. O puedes hacer clic en cualquier columna de la tabla que est\u00e1 dentro del macro de filtro, y se realizar\u00e1 la clasificaci\u00f3n por esa columna. <\/p>\n

\"Dise\u00f1o
\n
\nPor ejemplo, tienes la misma tabla con los postulantes y necesitas estimar cu\u00e1ntas entrevistas se realizaron en un mes determinado; clasifica por fecha y disfr\u00fatalo.<\/p>\n

Tablas din\u00e1micas (plugin de pago)<\/h3>\n

\nAhora pasemos a un caso m\u00e1s interesante. Imagina que tu tabla es enorme y necesitas hacer algunos c\u00e1lculos sobre ella. Por supuesto, puedes copiarla a Excel, calcular lo necesario y cargar los datos de nuevo a Confluence. O puedes aplicar una vez el macro \u00abTabla din\u00e1mica\u00bb<\/a><\/noindex> y obtener el mismo resultado, pero adem\u00e1s actualizado.<\/p>\n

Por ejemplo: tienes una tabla que recopila datos de todos los empleados: d\u00f3nde se encuentran geogr\u00e1ficamente y qu\u00e9 puestos ocupan. Para contar cu\u00e1ntas personas hay en cada ciudad, debes elegir en el macro \u00abTabla din\u00e1mica\u00bb la fila por la que se agregan los datos (ubicaci\u00f3n) y el tipo de operaci\u00f3n (suma).<\/p>\n

\"Dise\u00f1o
\n
\nPor supuesto, puedes agrupar por varios criterios a la vez, todas las posibilidades se pueden consultar en la documentaci\u00f3n<\/a><\/noindex>.<\/p>\n

Gr\u00e1ficos (plugin de pago)<\/h3>\n

\nComo ya mencion\u00e9, no a todos les gustan las tablas tanto como a m\u00ed. Desafortunadamente, la mayor\u00eda de los gerentes no las quieren en absoluto. Sin embargo, a todos les gustan los gr\u00e1ficos coloridos.
\nLos creadores de Confluence, sin duda, lo sab\u00edan (seguramente tambi\u00e9n tienen jefes que aman los informes y gr\u00e1ficos, \u00bfqui\u00e9n no?). Por lo tanto, se puede utilizar el macro m\u00e1gico \u00abGr\u00e1fico a partir de tabla\u00bb<\/a><\/noindex>. En este macro se debe introducir la tabla din\u00e1mica del punto anterior, y voil\u00e0: tus datos grises y aburridos est\u00e1n bellamente visualizados.<\/p>\n

\"Dise\u00f1o
\n
\nPor supuesto, este macro tambi\u00e9n tiene configuraciones. El enlace a la documentaci\u00f3n de cualquier macro se puede encontrar en el modo de edici\u00f3n de dicho macro.<\/p>\n

La facilidad de agregaci\u00f3n<\/h2>\n

\nLa informaci\u00f3n de los puntos anteriores probablemente no fue una revelaci\u00f3n para usted. Pero ahora sabe exactamente c\u00f3mo utilizar macros, y yo puedo pasar a la parte m\u00e1s interesante del art\u00edculo.<\/p>\n

\"Dise\u00f1o
\n<\/p>\n

Etiquetas<\/h3>\n

\nEs problem\u00e1tico cuando la gente guarda informaci\u00f3n en un solo art\u00edculo no estructurado o en una enorme tabla. A\u00fan peor es cuando partes de esta informaci\u00f3n no solo est\u00e1n mal redactadas, sino que tambi\u00e9n est\u00e1n esparcidas por los rincones de Confluence. Afortunadamente, hay una manera de recopilar informaci\u00f3n dispersa en un solo lugar. Para ello, debes utilizar etiquetas<\/a><\/noindex> (conocidas por todos en las redes sociales como hashtags).<\/p>\n

\"Dise\u00f1o
\n
\nCualquier p\u00e1gina puede tener una cantidad ilimitada de etiquetas. Si haces clic en una etiqueta, ser\u00e1s dirigido a una p\u00e1gina de agregaci\u00f3n, donde encontrar\u00e1s enlaces a todos los materiales con esa etiqueta, as\u00ed como a un conjunto de etiquetas relacionadas. Las etiquetas relacionadas son aquellas que a menudo aparecen en la misma p\u00e1gina.<\/p>\n

\"Dise\u00f1o
\n<\/p>\n

Propiedades de las p\u00e1ginas<\/h3>\n

\nTambi\u00e9n puedes agregar otro macro interesante a la p\u00e1gina para estructurar la informaci\u00f3n: \u00abPropiedades de las p\u00e1ginas\u00bb<\/a><\/noindex>. Dentro de \u00e9l, debes presentar una tabla de dos columnas, siendo la primera la clave y la segunda el valor de la propiedad. Adem\u00e1s, el macro se puede ocultar de la p\u00e1gina para que no interfiera en la lectura del contenido, pero, aun as\u00ed, la p\u00e1gina estar\u00e1 marcada con las claves necesarias.<\/p>\n

\"Dise\u00f1o
\n
\nPresta atenci\u00f3n al ID: es conveniente asignarlo para enlazar diferentes grupos de propiedades a diferentes p\u00e1ginas (o incluso diferentes grupos de propiedades en una misma p\u00e1gina). <\/p>\n

Informes<\/h3>\n

\nSe pueden generar informes basados en etiquetas. Por ejemplo, el macro \u00abInforme de contenido\u00bb<\/a><\/noindex> recopila todas las p\u00e1ginas con un conjunto espec\u00edfico de etiquetas.<\/p>\n

\"Dise\u00f1o
\n
\nPero el informe m\u00e1s interesante es el macro \u00abInforme de propiedades de p\u00e1gina\u00bb<\/a><\/noindex>. Este tambi\u00e9n re\u00fane todas las p\u00e1ginas con un conjunto espec\u00edfico de etiquetas, pero en lugar de simplemente mostrar una lista, crea una tabla (\u00bfcaptas la conexi\u00f3n con el principio del art\u00edculo?), donde las columnas son las claves de las propiedades de la p\u00e1gina.<\/p>\n

\"Dise\u00f1o
\n
\nSe genera una tabla resumen con informaci\u00f3n de diferentes fuentes. Es agradable notar que tiene funciones \u00fatiles: dise\u00f1o adaptable, clasificaci\u00f3n por cualquier columna. Adem\u00e1s, esta tabla de informes se puede configurar dentro del macro. <\/p>\n

\"Dise\u00f1o
\n
\nAl configurarlo, se pueden eliminar algunas columnas del informe, establecer un estado predeterminado o la cantidad de registros a mostrar. Tambi\u00e9n se puede asignar un ID a la propiedad de la p\u00e1gina para ver solo la informaci\u00f3n relevante.<\/p>\n

Por ejemplo, tienes m\u00faltiples p\u00e1ginas de empleados, y esas p\u00e1ginas tienen un conjunto de propiedades sobre la persona: qu\u00e9 nivel tiene, d\u00f3nde se encuentra, cu\u00e1ndo se uni\u00f3 al equipo, etc. Estas propiedades est\u00e1n marcadas ID = employee_inf<\/i>. Y hay un segundo conjunto de propiedades en la misma p\u00e1gina, que recopila informaci\u00f3n sobre la persona como parte del equipo: qu\u00e9 rol desempe\u00f1a, en qu\u00e9 equipo se encuentra, etc. Estas propiedades est\u00e1n marcadas ID = team_inf<\/i>. As\u00ed que al compilar un informe, puedes mostrar solo informaci\u00f3n de un ID o de dos directamente, seg\u00fan sea m\u00e1s conveniente.<\/p>\n

La belleza de este enfoque es que cada uno puede recopilar la tabla de informaci\u00f3n que necesita, que no duplicar\u00e1 nada y se actualizar\u00e1 con la actualizaci\u00f3n de la p\u00e1gina principal. Por ejemplo: al l\u00edder de equipo no le importa cu\u00e1ndo se unieron sus desarrolladores, pero s\u00ed le importa qu\u00e9 rol desempe\u00f1a cada uno en el equipo. El l\u00edder de equipo recopilar\u00e1 su informe sobre el equipo. Y al contador no le importa qui\u00e9n cumple qu\u00e9 rol, pero s\u00ed le importan los t\u00edtulos \u2014 \u00e9l recopilar\u00e1 su informe sobre los puestos. Al mismo tiempo, la fuente de informaci\u00f3n no se duplicar\u00e1 ni se transferir\u00e1.<\/p>\n

El proceso final<\/h2>\n

<\/p>\n

Instrucci\u00f3n<\/h3>\n

\nEntonces, podemos estructurar de manera hermosa y agregar informaci\u00f3n de manera efectiva en Confluence usando macros. Pero en un mundo ideal, se deber\u00eda hacer para que la nueva informaci\u00f3n est\u00e9 inmediatamente estructurada y sea capturada en todos los mecanismos de agregaci\u00f3n ya utilizados.<\/p>\n

Aqu\u00ed la combinaci\u00f3n de macros y plantillas ser\u00e1 de ayuda. Para obligar a las personas a crear nuevas p\u00e1ginas en el formato correcto, se puede usar la macro \"Crear desde plantilla\". Esta macro a\u00f1ade un bot\u00f3n en la p\u00e1gina, que al ser presionado crea una nueva p\u00e1gina desde la plantilla que necesites. As\u00ed, obligas a las personas a trabajar de inmediato en el formato que necesitas. <\/p>\n

\"Dise\u00f1o
\n
\nEn la plantilla desde la cual permites crear la p\u00e1gina, es necesario a\u00f1adir previamente etiquetas, la macro \"Propiedades de la p\u00e1gina\" y la tabla de propiedades que necesites. Tambi\u00e9n recomiendo agregar instrucciones sobre qu\u00e9 valores deben rellenar la p\u00e1gina y los valores de las propiedades.<\/p>\n

\"Dise\u00f1o
\n
\nEntonces, el proceso final se ver\u00e1 as\u00ed:<\/p>\n

    \n
  1. Creas una plantilla para informaci\u00f3n de un tipo espec\u00edfico.<\/li>\n
  2. En esta plantilla, a\u00f1ades etiquetas y propiedades de la p\u00e1gina en la macro.<\/li>\n
  3. En cualquier lugar conveniente, crea una p\u00e1gina ra\u00edz con un bot\u00f3n, al hacer clic en el cual se crea una p\u00e1gina hija a partir de una plantilla. <\/li>\n
  4. Permite que los usuarios potenciales que generar\u00e1n la informaci\u00f3n necesaria (seg\u00fan la plantilla requerida, haciendo clic en el bot\u00f3n) accedan a la p\u00e1gina ra\u00edz.<\/li>\n
  5. Recopilas un informe sobre las propiedades de la p\u00e1gina a trav\u00e9s de las etiquetas que especificaste en la plantilla.<\/li>\n
  6. Te alegras: tienes toda la informaci\u00f3n necesaria en un formato conveniente. <\/li>\n<\/ol>\n

    \"Dise\u00f1o
    \n<\/p>\n

    Puntos ocultos<\/h3>\n

    \nComo ingeniero de calidad, puedo afirmar con confianza que nada en el mundo es perfecto. Incluso las tablas divinas no son perfectas. Y en el proceso mencionado anteriormente hay puntos ocultos.<\/p>\n