Skip to main content

PL01: Estándar

Última edición: October 2, 2025 11:14 AM Propietario: Daniel Queijeiro Albo Fecha de creación: August 25, 2025 3:02 PM

Esta plantilla proporciona una estructura estandarizada para crear y documentar estándares técnicos y organizacionales dentro de la organización. Siguiendo este formato, se asegura que todos los estándares sean claros, aplicables y estén correctamente documentados para su implementación efectiva.

🎯 Objetivo​

  • Proporcionar un formato estándar para documentar estándares técnicos y organizacionales.
  • Facilitar la implementación y verificación de criterios de calidad consistentes.
  • Asegurar que todos los estándares documentados contengan la información esencial para su correcta aplicación.

📏 [PLXX: Nombre del Estándar]

[Breve descripción del estándar y su importancia dentro de la organización]

🎯 Objetivo​

  • [Definir el propósito principal del estándar].
  • [Explicar la necesidad que cubre o problema que resuelve].
  • [Mencionar los beneficios esperados de su implementación].

📑 Artefactos en los que aplica​

  • [Artefacto/documento 1]: [Link (si aplica)]
  • [Artefacto/documento 2]: [Link (si aplica)]
  • [Artefacto/documento 3]: [Link (si aplica)]

📋 Estándares​

[Categoría o grupo de estándares 1]​

  • [Estándar 1]: [Descripción clara y verificable]
  • [Estándar 2]: [Descripción clara y verificable]
  • [Estándar 3]: [Descripción clara y verificable]

[Categoría o grupo de estándares 2]​

  • [Estándar 1]: [Descripción clara y verificable]
  • [Estándar 2]: [Descripción clara y verificable]
  • [Estándar 3]: [Descripción clara y verificable]

📝 Ejemplos​

✅ Correcto​

[Ejemplo de implementación correcta del estándar]

❌ Incorrecto​

[Ejemplo de implementación incorrecta del estándar]

📎 Recursos relacionados​

  • [Recurso]

🧩 Ejemplo de uso​

Esta plantilla debe utilizarse para documentar estándares organizacionales como:

  • Estándares de codificación
  • Estándares de documentación
  • Estándares de arquitectura
  • Estándares de interfaz de usuario

🖥️ Estándar de Nomenclatura de Variables

Este estándar establece las convenciones a seguir para nombrar variables en todos los proyectos de desarrollo de software de la organización, asegurando consistencia, legibilidad y mantenibilidad del código.

🎯 Objetivo​

  • Establecer reglas claras y consistentes para la nomenclatura de variables en el código.
  • Mejorar la legibilidad y mantenibilidad del código a través de nombres significativos.
  • Facilitar la colaboración entre equipos de desarrollo al seguir una convención común.

📑 Artefactos en los que aplica​

  • Código fuente en todos los lenguajes de programación
  • Documentación técnica
  • Comentarios en el código
  • Nombres de constantes y variables de entorno

📋 Estándares​

Convenciones generales​

  • Las variables deben tener nombres descriptivos que reflejen su propósito.
  • Utilizar inglés para todos los nombres de variables.
  • Evitar abreviaturas ambiguas o poco comunes.

Convención por tipo de variable​

  • Variables locales: Utilizar camelCase (ej. userName, totalAmount).
  • Constantes: Utilizar UPPER_SNAKE_CASE (ej. MAX_CONNECTIONS, API_TIMEOUT).
  • Variables privadas: Prefijo con guión bajo seguido de camelCase (ej. _privateVariable).
  • Variables booleanas: Prefijo con "is", "has", o "should" (ej. isActive, hasPermission).

Estándar para arreglos y colecciones​

  • Usar nombres en plural para indicar colecciones (ej. users, productList).
  • Para iteradores, usar nombres significativos en lugar de i, j, k (ej. userIndex, productIndex).

📝 Ejemplos​

✅ Correcto​

const MAX_RETRY_COUNT = 3;
let isUserLoggedIn = false;
const userProfiles = getUserProfiles();
for (let profileIndex = 0; profileIndex < userProfiles.length; profileIndex++) {
  const currentProfile = userProfiles[profileIndex];
  processUserProfile(currentProfile);
}

❌ Incorrecto​

const m = 3;
let flag = false;
const data = getData();
for (let i = 0; i < data.length; i++) {
  const x = data[i];
  process(x);
}

📎 Recursos relacionados​