Wiki del Proyecto
La Wiki del Proyecto es tu centro de documentación. Crea páginas para guías, especificaciones técnicas, procesos y cualquier conocimiento que el equipo necesite. A diferencia de documentos individuales, la wiki ofrece estructura jerárquica y versionado automático.
El Problema que Resuelve
La documentación dispersa se pierde y desactualiza. Una wiki centralizada mantiene todo el conocimiento accesible, versionado y fácil de encontrar. Nuevos miembros del equipo encuentran información sin depender de otros.
Casos de Uso Principales
| Caso de Uso | Descripción | Ejemplo |
|---|---|---|
| Onboarding | Guías para nuevos miembros | Cómo configurar ambiente |
| Procesos | Procedimientos del equipo | Flujo de code review |
| Arquitectura | Decisiones técnicas | ADRs (Architecture Decision Records) |
| APIs | Documentación técnica | Endpoints y ejemplos |
| Runbooks | Procedimientos de operaciones | Cómo responder a incidentes |
| FAQs | Preguntas frecuentes | Problemas comunes |
Lo Que Ves
Árbol de Páginas
Panel lateral con navegación jerárquica:
| Elemento | Descripción |
|---|---|
| Páginas principales | Nivel raíz del árbol |
| Subpáginas | Anidadas bajo páginas padre |
| Indicador de recientes | Badge en páginas actualizadas |
| Barra de búsqueda | Buscar en todo el wiki |
| Botón nueva página | Crear nueva página |
Organización típica:
📁 Inicio
📄 Bienvenida
📄 Cómo usar este wiki
📁 Desarrollo
📄 Setup de Ambiente
📄 Guía de Estilo
📄 Testing
📁 Procesos
📄 Code Review
📄 Deploy
📄 Incidentes
📁 APIs
📄 Autenticación
📄 Endpoints
📄 WebhooksEditor de Página
Editor completo con:
| Característica | Descripción |
|---|---|
| Editor visual | WYSIWYG para no-técnicos |
| Modo Markdown | Para usuarios avanzados |
| Imágenes | Subir y embeber |
| Tablas | Crear y editar visualmente |
| Código | Syntax highlighting |
| Enlaces | A páginas internas y externas |
| TOC | Tabla de contenidos automática |
Creando Páginas
Pasos Básicos
- Navega a la sección Wiki del proyecto
- Haz clic en "Nueva Página"
- Ingresa un título descriptivo
- Selecciona página padre (opcional, para subpáginas)
- Escribe el contenido
- Haz clic en Guardar
Formato Markdown
Soporta sintaxis Markdown completa:
| Elemento | Sintaxis | Resultado |
|---|---|---|
| Título 1 | # Título | Encabezado grande |
| Título 2 | ## Título | Subencabezado |
| Negrita | texto | texto |
| Cursiva | texto | texto |
| Lista | - item | • item |
| Código inline | ` código ` | código |
| Enlace | texto | enlace clicable |
| Imagen | !alt | imagen embebida |
Bloques de Código
Para código con syntax highlighting:
~~~markdown
function ejemplo() {
return "Hola Mundo";
}~~~
Lenguajes soportados: JavaScript, TypeScript, Python, Ruby, PHP, Go, Rust, SQL, Bash, JSON, YAML, HTML, CSS, y más.
Tablas
Crear tablas con Markdown:
| Columna 1 | Columna 2 | Columna 3 |
|-----------|-----------|-----------|
| Dato 1 | Dato 2 | Dato 3 |
| Dato 4 | Dato 5 | Dato 6 |Plantillas
Usa plantillas predefinidas para empezar rápido:
| Plantilla | Uso | Contenido |
|---|---|---|
| Especificación técnica | Documentar features | Objetivo, alcance, diseño |
| Guía de proceso | Procedimientos | Pasos, responsables, checklist |
| Notas de reunión | Registrar meetings | Asistentes, temas, acciones |
| Documentación de API | Endpoints | URL, métodos, ejemplos |
| ADR | Decisiones técnicas | Contexto, decisión, consecuencias |
| Runbook | Operaciones | Problema, síntomas, solución |
Organizando Páginas
Jerarquía
Crea estructura lógica con páginas padre/hijo:
Buenas prácticas:
- Máximo 3 niveles de profundidad
- Nombres descriptivos y cortos
- Páginas de índice en cada sección
- Ordenar por frecuencia de uso
Arrastrar y Soltar
Reorganiza fácilmente:
- Haz clic y mantén en una página
- Arrastra a la nueva ubicación
- Suelta para confirmar
- La estructura se actualiza automáticamente
Mover Página
- Haz clic derecho en la página
- Selecciona "Mover a..."
- Elige nueva ubicación
- Confirma
Reordenar
Cambia el orden de páginas hermanas:
- Arrastra verticalmente
- El orden se guarda automáticamente
Editando Páginas
Editor Visual
Para usuarios no técnicos:
- Barra de herramientas familiar (similar a Word)
- Insertar imágenes con botón
- Crear tablas visualmente
- Formatear texto con clicks
Modo Markdown
Para usuarios técnicos:
- Escribir Markdown directamente
- Vista previa en tiempo real
- Atajos de teclado
Atajos de Teclado
| Atajo | Acción |
|---|---|
Ctrl+B | Negrita |
Ctrl+I | Cursiva |
Ctrl+K | Insertar enlace |
Ctrl+S | Guardar |
Ctrl+Shift+P | Vista previa |
Imágenes
Agregar imágenes:
- Subir: Haz clic en el icono de imagen, sube archivo
- Arrastrar: Arrastra imagen al editor
- Pegar: Pega imagen del clipboard
- URL externa: Usa sintaxis Markdown
Formatos: JPG, PNG, GIF, SVG, WEBP Tamaño máximo: 5 MB por imagen
Historial de Versiones
Ver Cambios
Cada página mantiene historial completo:
| Información | Descripción |
|---|---|
| Versión | Número secuencial |
| Autor | Quién editó |
| Fecha | Cuándo se editó |
| Resumen | Cambios realizados |
| Diff | Comparación con versión anterior |
Acceder al Historial
- Abre la página
- Haz clic en "Historial" o icono de reloj
- Ve lista de todas las versiones
- Haz clic en una versión para ver contenido
Comparar Versiones
- En historial, selecciona dos versiones
- Haz clic en "Comparar"
- Ve diferencias resaltadas:
- 🟢 Verde: Agregado
- 🔴 Rojo: Eliminado
- 🟡 Amarillo: Modificado
Restaurar Versión
- Abre historial de la página
- Encuentra la versión a restaurar
- Haz clic en "Restaurar"
- Confirma la acción
- La versión se convierte en actual (versión anterior se mantiene en historial)
Búsqueda
Búsqueda Rápida
- Usa la barra de búsqueda en el wiki
- Escribe términos de búsqueda
- Resultados aparecen en tiempo real
Búsqueda Avanzada
| Operador | Uso | Ejemplo |
|---|---|---|
| Comillas | Frase exacta | "código de ejemplo" |
| author: | Por autor | author:maria |
| updated: | Por fecha | updated:last-week |
| title: | Solo en título | title:API |
Resultados
Cada resultado muestra:
- Título de la página
- Fragmento con término resaltado
- Ruta (ubicación en jerarquía)
- Última actualización
Enlaces
Enlaces Internos
Enlaza a otras páginas del wiki:
[Ver guía de setup](/wiki/desarrollo/setup)Autocompletado: Al escribir [[ aparecen sugerencias de páginas.
Enlaces Externos
[Documentación oficial](https://ejemplo.com/docs)Enlaces a Secciones
[Ver sección de APIs](#apis)Enlaces Rotos
El sistema detecta enlaces rotos:
- Alerta al guardar si página destino no existe
- Reportes de enlaces rotos disponibles
Colaboración
Edición Simultánea
Múltiples usuarios pueden editar diferentes páginas simultáneamente.
Mismo página:
- Indicador de quién está editando
- Alerta antes de sobrescribir
- Merge automático si es posible
Comentarios en Páginas
Agregar comentarios sin editar contenido:
- Selecciona texto
- Haz clic en "Comentar"
- Escribe comentario
- El autor recibe notificación
Menciones
Usa @usuario para notificar a alguien sobre el contenido.
Exportar e Importar
Exportar Página
- Abre la página
- Menú ⋮ > "Exportar"
- Elige formato:
- Markdown: Archivo .md
- PDF: Documento formateado
- HTML: Para web
Exportar Wiki Completo
- Ve a Configuración del Wiki
- Haz clic en "Exportar todo"
- Recibirás ZIP con todas las páginas
Importar
- Haz clic en "Importar"
- Sube archivo Markdown
- Elige ubicación
- Confirma
Permisos
| Acción | Propietario | Manager | Developer | Client |
|---|---|---|---|---|
| Ver wiki | ✓ | ✓ | ✓ | ✓ |
| Crear página | ✓ | ✓ | ✓ | — |
| Editar página | ✓ | ✓ | ✓ | — |
| Eliminar página | ✓ | ✓ | — | — |
| Ver historial | ✓ | ✓ | ✓ | ✓ |
| Restaurar versión | ✓ | ✓ | — | — |
| Exportar | ✓ | ✓ | ✓ | — |
Permisos por Página
Opcionalmente, configura permisos específicos por página:
- Abre configuración de la página
- Activa "Permisos personalizados"
- Define quién puede ver/editar
Mejores Prácticas
Estructura
- Página de inicio - Índice con enlaces principales
- Jerarquía clara - Organizar por tema
- Nombres descriptivos - Fáciles de buscar
- Profundidad limitada - Máximo 3 niveles
Contenido
- Actualizar regularmente - Información obsoleta es peor que ninguna
- Ser conciso - Ir al punto
- Usar ejemplos - Código y screenshots
- Vincular relacionados - Crear red de conocimiento
Colaboración
- Definir responsables - Quién mantiene cada sección
- Revisar periódicamente - Auditoría trimestral
- Pedir feedback - Mejora continua
- Celebrar contribuciones - Reconocer a contribuidores
Troubleshooting
Página No Se Guarda
- Verifica conexión a internet
- Revisa permisos de edición
- Copia contenido, recarga, pega de nuevo
Imágenes No Cargan
- Verifica tamaño (<5 MB)
- Usa formato soportado
- Revisa conexión
Enlaces Rotos
- Verifica que la página destino existe
- Revisa ortografía de la ruta
- Usa autocompletado
[[
Recursos Relacionados
- Documentos del Proyecto - Archivos adjuntos
- Discusiones - Conversaciones del equipo
- NoteVault - Notas personales
- Markdown Guide - Referencia de Markdown
Crear Página Wiki
Crea nuevas páginas wiki para documentar conocimiento, procesos y especificaciones técnicas. Las páginas pueden ser documentos de nivel raíz o subpáginas anidadas, soportando organización jerárquica profunda para necesidades de documentación complejas.
Crear una Página Raíz
Las páginas raíz aparecen en el nivel superior de tu árbol wiki.
Desde la Barra Lateral
- Haz clic en el botón "Crear Página" en la parte superior de la barra lateral
- El modal de creación se abre
- Ingresa el título de la página en el campo requerido
- Opcionalmente añade contenido inicial
- Haz clic en Crear
Desde Estado Vacío
Cuando el wiki no tiene páginas:
- Ve el mensaje de estado vacío
- Haz clic en "Crea tu primera página"
- Completa el modal de creación
- Tu primera página está lista
Crear una Subpágina
Las subpáginas se anidan bajo páginas existentes, construyendo documentación jerárquica.
Desde el Árbol de Páginas
- Pasa el cursor sobre la página padre en el árbol de la barra lateral
- Aparece un ícono "+" a la derecha
- Haz clic en el ícono "+"
- El modal se abre con contexto del padre
- Ingresa el título de la subpágina
- Haz clic en Crear
La nueva página se anida bajo el padre en el árbol de navegación.
Contexto del Padre
Al crear una subpágina, el modal muestra:
- Título de la página padre
- Indicador visual del anidamiento
- Confirmación de la jerarquía
Esto ayuda a confirmar que estás creando en la ubicación correcta.
Campos del Modal
Título de Página (Requerido)
Propósito: El nombre que aparece en la navegación y como encabezado de la página.
Pautas:
- Descriptivo y específico
- 3-100 caracteres
- Evita caracteres especiales que puedan causar problemas de URL
- Usa convenciones de nomenclatura consistentes
Buenos ejemplos:
- "Guía de Autenticación de API"
- "Desplegando a Producción"
- "Notas de Retrospectiva Sprint 23"
Evitar:
- Palabras únicas como "Notas" (muy genérico)
- Títulos muy largos (se truncan en navegación)
- Duplicar nombres de páginas existentes
Contenido Inicial (Opcional)
Propósito: Iniciar la página con contenido en lugar de en blanco.
Formato: Texto plano o formato estilo Markdown.
Casos de uso:
- Pegar contenido existente
- Comenzar desde plantilla
- Notas rápidas para expandir después
Si se deja en blanco, la página se crea vacía—puedes añadir contenido en modo edición después de la creación.
Después de la Creación
Navegación Inmediata
Después de hacer clic en Crear:
- El modal se cierra
- La nueva página aparece en el árbol
- El contenido de la página carga en el centro
- Puedes comenzar a editar inmediatamente
Vista de Página Vacía
Las nuevas páginas sin contenido inicial muestran:
- Título de la página como encabezado
- Área de contenido vacía
- Botón de editar para añadir contenido
Modo Edición
Para añadir contenido después de la creación:
- Haz clic en "Editar Página" en la barra lateral derecha
- La página entra en modo edición
- Añade tu contenido
- Haz clic en Guardar
Organización de Páginas
Elegir Ubicación
Antes de crear, decide la jerarquía:
Página raíz cuando:
- Categoría principal de documentación
- Referencia independiente
- Página índice o hub
Subpágina cuando:
- Relacionada con página existente
- Parte de tema más grande
- Expansión detallada del padre
Reestructurar Después
Las páginas pueden moverse después de la creación:
- Arrastrar y soltar en el árbol (si está habilitado)
- Editar página para cambiar padre
- Crear nueva página y copiar contenido
Consideraciones de Profundidad
Aunque el anidamiento ilimitado está soportado:
- 2-3 niveles es típicamente suficiente
- El anidamiento profundo hace la navegación más difícil
- Usa enlaces cruzados en lugar de árboles profundos
Plantillas
Crear Páginas de Plantilla
Configura plantillas reutilizables:
- Crea página llamada "[Plantilla] Notas de Reunión"
- Añade estructura con marcadores de posición
- Cuando se necesite, copia contenido de la plantilla a nueva página
Sugerencias de Plantillas
Notas de Reunión:
## Fecha: [FECHA]
## Asistentes:
-
## Agenda
1.
## Discusión
## Decisiones Tomadas
## Elementos de Acción
- [ ]
## Próxima Reunión:Especificación Técnica:
## Resumen
## Declaración del Problema
## Solución Propuesta
## Diseño Técnico
## Cambios de API
## Cambios de Base de Datos
## Estrategia de Pruebas
## Plan de DespliegueRunbook:
## Propósito
## Prerrequisitos
## Pasos
1.
2.
3.
## Verificación
## Rollback
## EscalaciónMejores Prácticas
Nombra Consistentemente
Establece convenciones del equipo:
- "Cómo..." para guías
- "[Componente] Arquitectura" para docs técnicos
- "AAAA-MM-DD Reunión" para notas
Comienza con Estructura
Incluso con contenido inicial vacío:
- Planifica tus encabezados
- Sabe qué secciones se necesitan
- Crea el esquema primero
Enlaza al Crear
Después de crear:
- Enlaza desde páginas relacionadas
- Añade a páginas índice
- Referencia en tareas relevantes
Establece Propiedad
Cada página debe tener un propietario:
- Responsable de actualizaciones
- Responde preguntas
- Revisa periódicamente
Permisos
La creación de páginas requiere permisos apropiados:
| Rol | Puede Crear Páginas |
|---|---|
| Agency Owner | ✓ |
| Manager | ✓ |
| Developer | ✓ |
| Client | ✗ (típicamente) |
La configuración del proyecto puede restringir más la creación.
Solución de Problemas
Botón crear deshabilitado:
- El campo de título puede estar vacío
- Verifica campos requeridos
- Verifica permisos
La página no aparece en el árbol:
- El árbol puede necesitar actualización
- Busca errores de creación
- Intenta navegar fuera y volver
No puedo crear subpágina:
- La página padre debe ser válida
- Verifica permisos
- Asegura que el padre no esté archivado
Error de título ya existe:
- Los nombres de página deben ser únicos dentro del proyecto
- Añade especificidad al título
- Busca página similar existente
Atajos de Teclado
| Acción | Atajo |
|---|---|
| Enviar formulario | Cmd/Ctrl + Enter |
| Cerrar modal | Escape |
| Enfocar título | Auto-enfocado al abrir |
Historial de Revisiones del Wiki
Cada página wiki mantiene un historial de versiones completo. Cada guardado crea una revisión, permitiéndote ver versiones pasadas, comparar cambios, entender quién modificó qué, y restaurar contenido previo si es necesario.
Entendiendo las Revisiones
Qué Es una Revisión
Una revisión es una instantánea guardada de una página en un momento específico:
- Contenido: Texto completo de la página al momento de guardar
- Título: Título de la página (si cambió)
- Autor: Quién hizo el cambio
- Marca de tiempo: Cuándo se guardó
- Número de revisión: Identificador secuencial
Cuándo se Crean Revisiones
Nueva revisión creada cuando:
- Página creada por primera vez (revisión 1)
- Modo edición guardado con cambios
- Restauración desde versión anterior
- Operaciones de importación o actualización masiva
Retención de Revisiones
Todas las revisiones se preservan indefinidamente:
- Sin purga automática
- Rastro de auditoría completo
- Almacenamiento optimizado para texto
Acceder al Historial de Revisiones
Desde la Vista de Página
- Selecciona una página wiki
- Mira en la barra lateral derecha
- Encuentra el botón "Historial de Revisiones"
- Muestra conteo de revisiones (ej., "Historial de Revisiones (12)")
- Haz clic para abrir el modal
Modal de Revisiones
El modal muestra:
- Lista de todas las revisiones
- Más reciente primero (orden descendente)
- Cada entrada muestra: fecha, autor, resumen
- Navegación para listas largas
Lista de Revisiones
Información de la Entrada
Cada revisión muestra:
| Campo | Descripción |
|---|---|
| Revisión # | Número secuencial |
| Fecha | Cuándo se guardó (relativa o absoluta) |
| Autor | Quién hizo el cambio |
| Vista previa | Fragmento o resumen del cambio |
Identificar Cambios
Las revisiones pueden indicar:
- "Página creada" para primera revisión
- "Contenido actualizado" para ediciones
- "Título cambiado" si el título se modificó
- "Restaurada desde revisión X" para restauraciones
Ver una Revisión
Vista Previa del Contenido
- Haz clic en cualquier revisión en la lista
- El panel de vista previa muestra el contenido
- Vista de solo lectura de esa versión
- Contenido completo de la página mostrado
Comparar con Actual
La vista previa indica claramente:
- Este es contenido histórico
- La versión actual puede diferir
- Opción de restaurar disponible
Comparar Revisiones
Abrir Vista de Diferencias
- En el modal de revisiones, selecciona primera revisión
- Mantén Ctrl/Cmd y selecciona segunda revisión
- Haz clic en el botón "Comparar"
- Se abre el modal de diferencias
Entendiendo las Diferencias
La comparación muestra:
Contenido añadido: Resaltado en verde Contenido eliminado: Resaltado en rojo Sin cambios: Visualización normal
Vista Línea por Línea
Las diferencias muestran cambios contextualmente:
- Líneas añadidas marcadas con +
- Líneas eliminadas marcadas con -
- Contexto circundante para claridad
Diferencias a Nivel de Carácter
Dentro de líneas cambiadas:
- Cambios específicos de palabras resaltados
- Seguimiento de modificaciones detalladas
- Más fácil detectar ediciones pequeñas
Restaurar Revisiones
Cuándo Restaurar
La restauración es útil cuando:
- Eliminación accidental de contenido
- La versión anterior era mejor
- Deshacer cambios de otra persona
- Recuperarse de errores
Proceso de Restauración
- Abre el historial de revisiones
- Selecciona la revisión deseada
- Vista previa para confirmar versión correcta
- Haz clic en el botón "Restaurar"
- Confirma la restauración
Después de la Restauración
- Contenido de la página reemplazado con versión antigua
- Nueva revisión creada (restauración registrada)
- Versiones originales preservadas
- Autor de la restauración registrado
La Restauración es Reversible
La restauración crea una nueva revisión, así que:
- Puedes restaurar de nuevo
- Nada se pierde permanentemente
- Rastro de auditoría completo mantenido
Auditar Cambios
Quién Cambió Qué
El historial de revisiones responde:
- ¿Quién editó esta página por última vez?
- ¿Cuándo apareció contenido específico?
- ¿Cómo se veía antes?
- ¿Cómo ha evolucionado?
Uso de Cumplimiento
Para entornos regulados:
- Historial de cambios completo
- Responsabilidad del autor
- Verificación de marca de tiempo
- Sin historial eliminado
Responsabilidad del Equipo
Las revisiones ayudan con:
- Entrenar nuevos editores
- Revisar contribuciones
- Entender evolución de documentación
- Resolver ediciones conflictivas
Mejores Prácticas
Guardados Significativos
No guardes cambios vacíos o triviales:
- Completa unidades lógicas de trabajo
- Evita commits de "arreglar typo"
- Agrupa cambios relacionados
Checkpoints Regulares
Para sesiones de edición largas:
- Guarda periódicamente
- Cada guardado es un punto de recuperación
- Mejor tener revisiones extra
Revisa Antes de Restaurar
Antes de restaurar contenido antiguo:
- Vista previa de la revisión
- Verifica qué podría perderse
- Considera copiar-pegar en su lugar
- Documenta por qué restauras
Limpia a Través de Edición
En lugar de restaurar versiones antiguas:
- Edita la versión actual para arreglar
- Mantén mejoras acumuladas
- Rollback selectivo cuando sea necesario
Limitaciones
Sin Restauración Parcial
La restauración reemplaza la página completa:
- No puedes restaurar un solo párrafo
- Copia-pega para recuperación parcial
- Merge manual si es necesario
No Eliminar Revisiones
Las revisiones individuales no pueden eliminarse:
- Historial completo preservado
- Por diseño para propósitos de auditoría
- Contacta soporte para casos extremos
Revisiones Grandes
Páginas muy grandes pueden:
- Tomar más tiempo para hacer diff
- Tener vistas previas truncadas
- Aún funcionar correctamente
Escenarios Comunes
Eliminación Accidental de Contenido
- Nota que falta contenido
- Abre historial de revisiones
- Encuentra última revisión con el contenido
- Vista previa para confirmar
- Restaura o copia-pega
Edición No Deseada por Miembro del Equipo
- Ve un cambio con el que no estás de acuerdo
- Abre historial de revisiones
- Encuentra revisión pre-cambio
- Discute con el equipo primero
- Restaura si se acuerda
Entender la Evolución
- Nuevo en el documento
- Abre historial de revisiones
- Navega a través de las versiones
- Entiende cómo evolucionaron las decisiones
- Obtén contexto del estado actual
Resolución de Conflicto de Merge
Cuando dos personas editaron:
- Ve contenido inesperado
- Compara revisiones recientes
- Identifica ambas contribuciones
- Merge manual lo mejor de ambos
- Guarda versión combinada
Solución de Problemas
No se muestran revisiones:
- Página nueva tiene solo una revisión
- Verifica permisos para ver historial
- Intenta actualizar el modal
Diff no funciona:
- Selecciona exactamente dos revisiones
- Verifica compatibilidad del navegador
- Páginas muy grandes pueden causar timeout
La restauración falla:
- Verifica permisos de edición
- Verifica que la página no esté bloqueada
- Problemas de red pueden interrumpir
La revisión antigua se ve mal:
- El formato cambia con el tiempo
- El contenido es preciso
- El renderizado puede diferir
Permisos
El acceso a revisiones sigue los permisos de la página:
| Rol | Ver Historial | Restaurar |
|---|---|---|
| Agency Owner | ✓ | ✓ |
| Manager | ✓ | ✓ |
| Developer | ✓ | ✓ (páginas propias) |
| Client | ✓ (si vista habilitada) | ✗ |
Algunos entornos pueden restringir el acceso al historial.