Resumen
Es normal que la documentación te aburra, pero también es cierto que tu equipo la necesita. Con Windsurf desde Wave 12, la función Deep Wiki reduce el esfuerzo al mínimo y te guía paso a paso con contexto real del proyecto. Aquí verás cómo usarla para documentar y aprender, sin perder tiempo.
¿Qué es Deep Wiki de Windsurf y por qué agiliza la documentación?
La Deep Wiki es una ayuda contextual que entiende tu código y genera una explicación completa y accionable. Primero muestra un concepto claro y luego una definición con forma de uso, incluyendo términos como interface y type tal como aparecen en tu proyecto. Además, entrega ejemplos, notas y preguntas adicionales que amplían el entendimiento.
- Explicaciones basadas en el contexto real del project y sus items como talk y about.
- Recomendaciones de qué más revisar dentro del código relacionado.
- Tres acciones clave: refrescar para regenerar contenido, copiar artículo para llevarlo a Confluence, y agregar a Cascade como contexto para hacer preguntas.
¿Cómo usar Deep Wiki: atajos, panel e AI Actions?
Hay dos formas prácticas de interactuar con Deep Wiki. Ambas entregan claridad inmediata y documentación reutilizable.
- Atajo con Command Shift + clic sobre una función. Abre el panel izquierdo con el concepto, la definición completa, ejemplos y notas. Incluye detalles de interface y type tal como están en el código.
- Acciones del panel. Puedes refrescar el contenido, copiarlo como artículo y pegarlo donde tu equipo colabora, o agregarlo a Cascade como contexto para consultas.
- Botón de AI Actions al situar el cursor sobre una función. Selecciona Explain y se ejecuta un comando en la terminal o en Cascade. La explicación puede aparecer en inglés, pero si tu interacción es en español, la respuesta se adapta al español.
¿Qué resultados obtienes con Explain?
- Un ejemplo claro de uso y la estructura y tipado del elemento explicado.
- Identificación de si es una interfaz, el contenido de proyectos usado como mock y su uso dentro del componente.
- Puntos técnicos relevantes que describen el funcionamiento real en tu base de código.
¿Cómo aprender más rápido con repos de GitHub y Platzi?
La Deep Wiki también te sirve para aprender de código nuevo. Puedes descargar cualquier repo de GitHub, abrirlo en Windsurf y entender cada parte con explicaciones contextualizadas.
Un ejemplo práctico con un curso de Platzi:
- Abrir el repo del curso de PHP Avanzado en Windsurf.
- Ir a un archivo como el About Controller y pedir la explicación. La Deep Wiki detalla que es una clase responsable del manejo de request para la página de about. Además, muestra el type, el namespace y los métodos usados, con ejemplos de uso y recomendaciones para explorar archivos relacionados como Home Controller y Post Controller.
- Con Copiar artículo, puedes llevar la documentación a Confluence y compartirla con tu equipo. Si no hace falta documentar todo, basta con compartir el enlace del repo y enseñar cómo leer la Deep Wiki en Windsurf.
Beneficios que fortalecen tus habilidades:
- Documentación rápida y consistente sin salir del editor.
- Comprensión profunda del contexto del proyecto y sus relaciones.
- Exploración guiada de controladores, namespaces, types y interfaces con ejemplos reales.
- Reutilización de contenido en herramientas del equipo como Confluence y Cascade.
¿Ya usas Deep Wiki en tu flujo diario con Windsurf? Cuéntame en comentarios cómo te ayuda o qué te gustaría optimizar.