Guía de Usuario

Bienvenido a WikiRegional, el sistema de documentación interna de la empresa. Esta guía te ayudará a navegar y utilizar la wiki de manera efectiva.

Navegación

Barra lateral izquierda

La barra lateral muestra todos los documentos disponibles organizados jerárquicamente. Haz clic en cualquier título para acceder al documento.

Barra lateral derecha

En esta página: Muestra el índice de contenidos del documento actual. Haz clic en cualquier sección para navegar directamente.
Documentos relacionados: Enlaces a documentación relacionada con el tema actual.
Acciones rápidas: Acceso directo al editor CMS.

Búsqueda

Utiliza la barra de búsqueda en la parte superior para encontrar documentación:

Escribe al menos 2 caracteres
Los resultados aparecerán automáticamente
Cada resultado muestra el título y un fragmento del contenido
Haz clic en un resultado para ir al documento

Atajo de teclado: Presiona / en cualquier momento para enfocar la búsqueda.

Lectura de documentos

Estructura típica de un documento

Cada documento sigue una estructura consistente:

Título: Nombre del documento
Descripción: Resumen breve del contenido
Fecha de actualización: Cuándo se modificó por última vez
Responsables: Equipo o personas a cargo del documento

Bloques especiales

Los documentos pueden incluir bloques de información especiales:

Desde versión X

Indica funcionalidades nuevas o cambios recientes. Aparece con borde verde.

Cambió en versión X

Describe cambios respecto a versiones anteriores. Aparece con borde amarillo.

Obsoleto desde versión X

Indica funcionalidades que ya no se usan o están deprecadas. Aparece con borde rojo.

Descarga de documentos

Descargar PDF

Abre el documento que deseas descargar
Haz clic en el botón “Descargar PDF” en la cabecera del documento
El archivo PDF se descargará automáticamente

Imprimir

Haz clic en el botón “Imprimir”
Se abrirá el diálogo de impresión del navegador
Puedes imprimir directamente o guardar como PDF

Edición de documentos

Acceder al editor

Haz clic en “Editar” en la barra superior, o
Haz clic en “Editar esta página” en la barra lateral derecha
Serás redirigido al CMS (requiere autenticación con GitHub)

Requisitos para editar

Debes tener una cuenta de GitHub
Tu cuenta debe ser miembro de la organización autorizada
Debes estar conectado a la VPN de la empresa

Proceso de edición

Iniciar sesión: Autentícate con tu cuenta de GitHub
Seleccionar documento: Navega a “Documentación” y selecciona el documento
Editar contenido: Usa el editor visual o el modo raw (código)
Guardar cambios: Haz clic en “Publicar” para guardar

Editor visual vs. modo raw

Editor Visual	Modo Raw
Interfaz gráfica	Código Markdown/MDX
Ideal para texto simple	Ideal para contenido complejo
Formateo con botones	Control total del formato

Crear nuevo documento

Accede al CMS (/admin)
Haz clic en “Nuevo Documento”
Completa los campos obligatorios:
- Título: Nombre descriptivo
- Contenido: El cuerpo del documento
Campos opcionales recomendados:
- Descripción: Resumen para búsqueda
- Etiquetas: Palabras clave
- Responsables: Equipo a cargo
Haz clic en “Publicar”

Subir imágenes y archivos

Desde el editor

En el editor, posiciona el cursor donde quieres la imagen
Haz clic en el botón de imagen (+)
Selecciona “Subir” y elige el archivo
La imagen se guardará junto al documento

Formatos soportados

Imágenes: PNG, JPG, SVG, GIF, WebP
Videos: MP4, WebM
Documentos: PDF, DOCX (para descarga)

Buenas prácticas

Al escribir documentación

Sé claro y conciso: Evita tecnicismos innecesarios
Usa encabezados: Estructura el contenido con títulos y subtítulos
Incluye ejemplos: Los ejemplos prácticos ayudan a entender
Mantén actualizado: Revisa y actualiza cuando haya cambios
Usa imágenes: Una imagen vale más que mil palabras

Al buscar información

Usa términos específicos en la búsqueda
Revisa los documentos relacionados
Consulta el índice de contenidos (barra derecha)

Preguntas frecuentes

¿Por qué no puedo acceder a la wiki?

Verifica que estés conectado a la VPN de la empresa
La wiki no es accesible desde internet público

¿Por qué no puedo editar?

Verifica que tu cuenta de GitHub esté en la organización correcta
Contacta al administrador si necesitas permisos

¿Dónde reporto un error en la documentación?

Edita directamente el documento si tienes permisos
Contacta al equipo responsable del documento

¿Cómo sé si un documento está actualizado?

Revisa la fecha de “Última actualización” en la cabecera
Los documentos con estado “Obsoleto” están deprecados

Soporte

Si tienes problemas o preguntas:

Revisa esta guía de usuario
Consulta la Guía de Desarrollador para temas técnicos
Contacta al equipo de IT