Estrategias de arquitectura en Confluence
Confluence: más que una herramienta de gestión documental
Confluence es la herramienta desarrollada por Atlassian para crear, gestionar, compartir y publicar documentación. Su perfecta integración con Jira permite exprimir la multitud de opciones y características que encontraremos disponibles en su interior. Por ello, Confluence es diferente a cualquier otro CMS. Podría decirse que Confluence con Jira crean un perfecto equipo de trabajo.
La organización en Confluence es vital para mantener un buen control sobre el contenido que se va generando y compartiendo. Para facilitar esta tarea disponemos de ‘espacios’ en los cuales podremos crear páginas y compartir con miembros de nuestra organización o empresa. Se podría decir que los ‘espacios’ son contenedores que almacenan información.
Las páginas que se crean tienen una disposición en formato de árbol y se organizan jerárquicamente, facilitando así su búsqueda de una forma visual y rápida. Su contenido es dinámico y el uso de plantillas o etiquetas clave es una buena práctica que ayuda a mantener actualizada y estandarizada la información guiando en la creación a cualquier usuario.
Permisos en Confluence
Confluence ofrece 3 niveles de permisos:
- Permisos Globales: gestionados por administradores y que habilitan el acceso a la herramienta.
- Permiso de Espacio: gestionado por administradores del espacio y permiten visualizar, editar borrar, comentar o añadir adjuntos.
- Permiso de Página: gestionado por cualquier usuario que tenga permisos de edición y restricción del espacio. Estos permisos permiten restringir o la vista o edición de la página.
¿Qué arquitectura necesito?
Al crear un espacio nuevo a partir de una plantilla, se generarán páginas de ejemplo en el espacio, y la sugerencia de uso de las plantillas de páginas relacionadas; a partir de ahí, es posible modificar todo el espacio en base a las necesidades de organización de la arquitectura de información.
Utiliza:
- Espacios de equipos para animar a los miembros del equipo a trabajar juntos a fin de lograr objetivos y resultados clave a gran escala.
- Espacios de proyectos de software para llevar un seguimiento de las iniciativas y proyectos individuales.
- Espacios de documentación para crear y organizar la documentación técnica para tus productos y servicios, de forma que todo el mundo pueda usarlos fácilmente.
- Espacios de bases de conocimientos para almacenar y consultar respuestas a preguntas comunes, como las aclaraciones de políticas y soluciones de TI. Si tienes una suscripción a Jira Service Management, puedes integrarla en tu sitio de Confluence para compartir artículos de bases de conocimientos con los clientes.
- Espacio personal como espacio aislado para organizar tus notas, llevar un seguimiento de los objetivos y resultados clave personalizados, y elaborar propuestas de proyectos de cara a la creación de la hoja de ruta.
Pero, es muy importante que no pierdas de vista esta frase:
¡Antes de empezar a crear espacios, hay que diseñar la arquitectura!
- ¿Qué tipo de información necesito gestionar?
- ¿Cómo y cuándo se genera?
- ¿Cuál será su uso?
- ¿Es información relevante?
- ¿A quién le interesa la información?
- ¿Quién colabora en su creación?
- ¿Cómo y quién se mantiene la información actualizada?
- ¿Qué tipo de consultas necesito?
Hay que plantearse qué tipo de información tenemos, cómo la consultan los usuarios, cuántas personas acceden a los espacios, qué plantillas son necesarias… empezando por dónde nos encontremos ahora mismo, con la información que tengamos diseña una arquitectura que encaje con tu realidad.
Consideraciones importantes, buenas prácticas y errores comunes
A continuación, vamos a detallar algunas consideraciones a tener en cuenta, así como consejos de buenas prácticas y errores que podemos evitar:
- Intenta no duplicar nunca documentación, el origen de la información deber ser único.
- Si no sabemos dónde ubicar un documento, hay que revisar la arquitectura de la información o no se ha comunicado correctamente el para qué en cada apartado de la arquitectura.
- Usa la macro ‘Excerpt’ en cada página para informar sobre el objetivo y su contenido; así podrás recopilar la información desde otras páginas principales con ‘Excerpt Include’, en las búsquedas o con ‘Children Display’ seleccionando ‘Excerpt Display = rich content’:
- Agrupa contenidos en páginas de primer nivel en árbol de jerarquía estandarizando la estructura del contenido de las páginas hijas mediante el uso de plantillas y etiquetas:
- Establece la nomenclatura de las páginas según el tipo de información o contenido. Usa la macro ‘Create from Template’ para crear contenido dentro de cada página principal del árbol y para indicar la nomenclatura a seguir en el título de la nueva página creada a través de la plantilla:
- Establece un criterio de etiquetado y clasificación de contenido. Si añades etiquetas en las plantillas podrás clasificar las páginas automáticamente en su creación. Puedes usar la macro ‘Content by Label’ para organizar el contenido en una página de primer nivel o padre y sin necesidad de añadir más niveles en el árbol:
- Crea ‘Guías del espacio’ para ayudar en la creación de contenido. Puedes incluir vídeos explicativos en vez de guías paso a paso.
Carmen Climent y Marc Cano 7 de enero de 2023
