Skip to content
MAIUS MAIUS Docs

Guía de Estilo Interna para Documentación de Maius

Esta guía establece cómo redactar la documentación relacionada con la auditoría de sistemas en nuestra organización. Su objetivo es garantizar consistencia, claridad y profesionalismo, inspirándonos en los estilos de Microsoft, Google y GitLab.

1. Principios de escritura

Section titled “1. Principios de escritura”
  • Claridad primero: usar frases cortas y directas.
  • Voz activa: preferir “El sistema genera un reporte” en lugar de “Se genera un reporte por el sistema”.
  • Lenguaje sencillo: evitar jerga innecesaria o términos ambiguos.
  • Consistencia: siempre usar la misma terminología en todo el documento.

2. Estructura de los documentos

Section titled “2. Estructura de los documentos”

Cada sección debe responder, en orden:

  1. Qué es (descripción breve del control/proceso).
  2. Cómo funciona (procedimiento o política aplicada).
  3. Quién es responsable (rol o área encargada).
  4. Evidencia (logs, reportes, actas, capturas).

Ejemplo:

  • Qué es: Gestión de accesos de usuarios.
  • Cómo funciona: El área de TI crea y elimina usuarios según solicitudes de RRHH, usando tickets de soporte.
  • Quién es responsable: Jefe de Infraestructura.
  • Evidencia: Captura de Active Directory con lista de usuarios.

3. Estilo de títulos y subtítulos

Section titled “3. Estilo de títulos y subtítulos”
  • Los títulos deben ser claros y específicos.
  • Usar sustantivos en lugar de frases largas.
  • Ejemplo: ✅ “Gestión de accesos” | ❌ “Cómo se gestionan los accesos a los sistemas de la organización”.

4. Terminología

Section titled “4. Terminología”

  • Usar siempre los mismos términos. Ejemplos:

    • “Usuario” en lugar de mezclar con “cliente” o “colaborador”.
    • “Respaldo” en lugar de alternar con “backup”.
    • “Incidente de seguridad” en lugar de “problema”.

Se recomienda crear un glosario interno con términos clave.

5. Tono

Section titled “5. Tono”
  • Profesional y directo.
  • Evitar expresiones coloquiales.
  • Explicar el qué y el cómo sin redundancias.

Ejemplo:

  • ❌ “Normalmente hacemos copias de seguridad cada tanto.”
  • ✅ “Se realizan copias de seguridad diarias a las 22:00, almacenadas en la nube por 30 días.”

6. Ejemplo de sección documentada

Section titled “6. Ejemplo de sección documentada”

Título: Políticas de Respaldo y Restauración Qué es: Normas que aseguran la disponibilidad de la información. Cómo funciona: Se ejecutan respaldos diarios automáticos y pruebas de restauración cada trimestre. Quién es responsable: Administrador de Base de Datos. Evidencia: Reportes del software de backup y acta de la última prueba de restauración.

7. Revisión y mantenimiento

Section titled “7. Revisión y mantenimiento”
  • Todos los documentos deben revisarse cada 6 meses o tras un cambio relevante en los procesos.
  • Cada documento debe incluir fecha de última revisión y responsable de mantenerlo actualizado.

✅ Con esta guía aseguramos que nuestra documentación sea:

Section titled “✅ Con esta guía aseguramos que nuestra documentación sea:”
  • Clara y fácil de entender para auditores y personal interno.
  • Consistente en estilo, formato y terminología.
  • Respaldada con evidencias verificables.