Modelo de Estándar de Nombres

Estandarizar la nomenclatura es esencial para mantener consistencia a través de toda la configuración de los productos Atlassian. De todas formas, a pesar de ser una práctica muy común en IT, muchas veces como administradores de Atlassian fallamos en no darle la prioridad necesaria a esto en la plataforma. Esta publicación no apunta a identificar los beneficios de hacerlo, sino a compartir nuestro propio estándar que aplicamos una y otra vez en cada una de las instancias que administramos para nuestro clientes.

Dentro del contenido nos vamos a encontrar con las siguientes secciones:

  • Estructura General

  • Ítem a Configurar

  • Categoría

  • Plantilla de Proyecto

  • Número de Plantilla

  • Estado Destino

  • Opciones de Nombres

  • Ejemplos

Estructura General

Nuestro estándar siempre está basado en la siguiente estructura de secciones


<Ítem a Configurar>-<Categoría>-<Plantilla de Proyecto>-<Número de Plantilla>-<Acción/Estado Destino>


El orden siempre será el mismo, lo que puede variar es la cantidad de secciones que dependerá el nivel de granularidad de configuración que permite lo que estemos configurando. Por ejemplo, un esquema de flujos de trabajo solo puede configurarse a nivel proyecto, por lo cual las secciones de Número de Plantilla y Estado Destino no serían relevantes.


Opciones de Nombres

Acá iré desglozando cada una de las secciones para simplificar la comprensión de cómo se forma el nombre de lo que estamos configurando.


Sección Ítem a Configurar

La siguiente tabla muestra las opciones para esta sección. A raíz de que esto se originó mientras se trabajaba con un cliente de habla inglesa, sus siglas quedaron en base a los nombres de los ítem de configuración en dicho idioma.


ITSCH

Esquema de Tipos de Incidencias

WRK

Flujo de trabajo

WRKSCH

Esquema de Flujo de Trabajo

SCR

Pantalla

SCRSCH

Esquema de Pantallas

ITSCRSCH

Esquema de Pantallas por Tipo de Incidencia

CF

Campo Personalizado

FLD

Configuración de Campo

FLDSCH

Esquema de Configuración de Campo

NTFSCH

Esquema de Notificaciones

SECSCH

Esquema de Seguridad de Incidencias

PERMSCH

Esquema de Permisos

GRP

Grupo

APP

Ítem de Configuración de Aplicación

Claramente sobre esto uno puede hacer su propio ajuste, lo importante es que en esta sección brindamos información de el Qué estamos configurando, lo cual ha resultado de ser de gran utilidad para usuarios que se están iniciando en la administración de la herramienta.


Sección Categoría

En esta sección del nombre buscamos identificar que tan global y masivo es el uso de lo que estamos usando. En general se hace uso de las categorías de Jira o Confluence para agrupar proyectos que comparten ciertas características en común y en muchos casos, su configuración.

En nuestro caso, al momento de definir el nombre de la categoría, usamos la sección de la descripción para dejar definida la nomenclatura de cada una de ellas y así estandarizar los nombres a usar en esta sección como se puede apreciar en la imagen debajo.


Cada categoría lleva su nomenclatura en la descripción de la misma

Por fuera de las opciones que tengamos en las categorías, siempre tendremos una opción adicional que es ALL la cual, indica que la configuración puede impactar a proyectos de cualquier categoría. De esta forma, nuestras nomenclaturas pueden tener nombres que empiecen como WRKSCH-ALL o NTFSCH-ELT.


Sección Plantilla de Proyecto

Como su nombre lo indica, aquí estaremos llevando registro del proyecto al que aplica. En un escenario ideal, esta plantilla tendrá un número en vez de tener la identificación del proyecto. ¿Por qué? Porque nuestro objetivo siempre es reutilizar lo que creamos, si a nuestra configuración la asociamos al proyecto A, deberíamos de crear una copia del mismo para utilizar en el proyecto B y seguir la nomenclatura a la vez.

De manera similar a las categorías, acá es válido hacer uso de la opción ALL que me permitiría indicar que esto se usa para todos proyectos de una categoría. En algunos clientes incluso, las categorías tenían configuraciones varias pero todo nuevo proyecto debía empezar con la configuración por defecto de la categoría, por lo que también se sumó la opción DFT para identificar fácilmente cual era esta. Como se empieza a ver, en la medida que nos adentramos en el estándar, empezamos a tener mayor flexibilidad para identificar lo que estamos configurando sin perder el orden y entender el impacto.


Sección Número de Plantilla

Al llegar a este nivel de profundidad, nos estamos adentrando en configuraciones asociadas a los tipos de incidencias. Bajo el mismo criterio de reuso, nuestras opciones acá solamente serán números o bien la opción ALL. Poner el nombre del tipo de incidencia solo nos implicará duplicar la información si tenemos que reutilizar algo para más de un tipo de incidencia lo cual no escalaría y sería sumamente difícil de mantener.

Tip: si la numeración del tipo de incidencia es uno a uno entre los flujos de trabajo, con las pantallas y sus esquemas, facilitarás mucho la administración. Ya que sabrás que el flujo 1 siempre funcionará bien con la pantalla 1 y no habrá riesgo de romper algo en algún proyecto que potencialmente podría estar usando una configuración que no estuviese alineada en su numeración.

Particularmente, al momento de trabajar con grupos, esta sección se asocia directamente con el rol del proyecto, por lo que la nomenclatura se convierte en una abreviación del rol que corresponda como ser ADM, DEV, USR a modo de ejemplo.


Sección Acción/Estado Destino

Esta sección solamente es utilizada a nivel Pantallas ya que estas permiten mayor nivel de flexibilidad que otros ítem a configurar. De allí es que las opciones válidas son las siguientes

CREATE

Pantalla para la acción de crear incidencias

EDIT

Pantalla para la acción edición de campos

VIEW

Pantalla para la acción de Vista

ALL

Pantalla valida para cualquier acción

Nombre de estado destino

​Aplica para pantallas usadas durante transiciones en los flujos de trabajo

GLB#

Pantalla de uso global

La última opción de la lista tiene ciertas restricciones a fin de no hacer abuso de este tipo de pantallas. Esta nomenclatura está reservada a pantallas de uso global, donde todas las demás partes del nombre están catalogadas cómo ALL y como regla general, ninguna de estas pantallas debería de tener más de 3 campos. Simplemente por una cuestión lógica que a más opciones, menos probable que realmente se use para cualquier tipo de incidencia de cualquier proyecto de cualquier categoría.


Ejemplos

Suficiente teoría hasta acá, vamos a ejemplos prácticos para ver la nomenclatura en acción, solo para simplificar los ejemplos, los estaré agrupando bajo el tipo de configuraciones que aceptan los distintos niveles de profundidad


Ejemplo

Significado

WRKSCH-ALL-ALL

Esquema de flujo de trabajo para todos los proyectos de todas las categorías

ITSCH-ELT-1

Esquema de tipos de incidencia número 1 de la categoría Élite (ELT)

NTFSCH-DEV-ALL

Esquema de notificación para todos los proyectos de la categoría de desarrollo (DEV)

CF-CNF-ALL

Contexto de campo para todos los proyectos de la categoría confidencial (CNF)

Ejemplos de configuraciones de esquemas de configuración de campos, esquemas de tipo de incidencia, esquemas de flujos de trabajo, esquema de Pantallas por Tipo de Incidencia, esquema de Permisos, esquema de notificación, esquemas de seguridad de incidencias o campos personalizados.



Ejemplo

Significado

WRK-CSTM-FIN-1

Workflow 1, del proyecto Fintech (FIN) de la categoría personalizados (CSTM)

SCRSCH-ALL-ALL-3

Esquema de pantalla 3 para todos los proyectos de todas las categorías

GRP-CST-BNK-DEV

Grupo del rol desarrolladores (DEV) del proyecto Banco de la categoría cliente (CST)

GRP-CST-ALL-ADM

Grupo de rol administrador (ADM) para todos los proyectos de categoría cliente (CST)

Ejemplos de configuraciones de configuraciones de campo, esquemas de pantalla, flujos de trabajo, campos personalizados, grupos


Ejemplo

Significado

SCR-ALL-ALL-2-ALL

Pantalla 2 para todas las acciones (crear, ver y editar), para todos los proyectos de todas las categorías

SCR-ALL-ALL-ALL-GLB3

Pantalla de uso global número 3

SCR-SUP-SA-1-CLOSED

Pantalla de transición al estado cerrado (CLOSED), de la plantilla 1 para el proyecto de soporte Atlassian (SA), de la categoría soporte (SUP)

Ejemplos de configuraciones de configuraciones de pantallas


Bonus

Para el caso de que estés interesado en establecer tu propio estándar y quieras saber las consideraciones a tener en cuenta al momento de definirlos y algunos de los errores más comunes al momento de implementarlos te dejo un enlace al episodio de nuestro podcast que dedicamos a esto.






Tienes un criterio distinto para implementar lo presentado? Contanos en los comentarios

Es muy común que haya más de una forma de hacer las cosas con las herramientas de Atlassian y nos encantaría descubrir otras formas de resolver las mismas.

Esperamos hayas disfrutado la lectura,


Hasta la próxima.


0 comentarios

Entradas Recientes

Ver todo