¿Te aburre tanto como a mí escribir documentación? Deep Wiki en Windsurf es la funcionalidad que llegó con Wave 12 para minimizar ese esfuerzo y generar documentación de tu aplicación en tiempo real. Es ideal para desarrolladores que odian documentar pero necesitan hacerlo, y también para quienes quieren aprender leyendo proyectos ajenos.

¿Qué es Deep Wiki y cómo funciona en Windsurf?

Deep Wiki es una herramienta de Windsurf que explica tu código y genera documentación automáticamente a partir del contexto del proyecto. No inventa información externa: toma lo que está detallado en tu código y lo convierte en una explicación clara.

¿Qué es Deep Wiki en Windsurf? Es una funcionalidad lanzada en Wave 12 que genera documentación y explicaciones de tu código en tiempo real, leyendo el contexto real del proyecto para que documentar no sea una tarea tediosa.

Lo interesante es que trabaja con lo que ya tienes. Si defines una interfaz o un type, Deep Wiki te entrega un concepto, una definición completa, la forma de uso y ejemplos [00:38].

¿Cuáles son las dos formas de usar Deep Wiki?

Windsurf te da dos caminos para interactuar con esta herramienta, y cada uno sirve para momentos distintos.

¿Cómo abrir el panel con command + shift + clic?

La primera forma es hacer command, shift y clic directamente sobre una función [00:30]. Se abre un panel a la izquierda que te explica qué es esa función, empezando por un concepto y luego una definición completa.

Dentro de ese panel encuentras varias secciones útiles:

• Un bloque about con varios ítems descriptivos.
• Follow-up questions, que son preguntas adicionales para seguir explorando.
• Recomendaciones de qué otras partes del proyecto revisar.

Y aquí viene lo práctico: el panel te ofrece tres acciones sobre la documentación generada.

• Refrescarla para que vuelva a generarse con información más detallada.
• Copiar el artículo para llevarlo a un Confluence o a un archivo compartible con tu equipo.
• Agregarlo a Cascade como contexto para hacerle preguntas.

¿Qué hace el botón AI Actions con Explain?

La segunda forma aparece cuando posicionas el cursor sobre una función: Windsurf habilita un botón en la parte superior llamado AI Actions [02:10]. Al hacer clic y elegir Explain, ejecuta un comando que examina el código.

Lo responde en inglés durante la examinación, pero como has interactuado en español, te entrega la explicación en español. Ahí te detalla el ejemplo, la estructura, el tipado, que se trata de una interfaz y cómo se usa dentro del componente.

¿Deep Wiki responde en español o en inglés? Examina el código en inglés, pero te responde en el idioma en el que vienes interactuando. Si trabajas en español, la explicación final llega en español.

¿Cómo usar Deep Wiki para aprender de repos de GitHub?

Uno de los casos de uso más potentes es aprender. Puedes descargar cualquier proyecto de GitHub, abrirlo en Windsurf e ir entendiendo cada parte con Deep Wiki.

En la clase hacemos ese ejercicio con el repo del curso de PHP avanzado de Platzi [03:31]. El link al repositorio queda en los recursos para que sigas los mismos pasos.

Al abrir el About Controller y aplicar command, shift y clic, Deep Wiki explica que es una clase responsable del manejo de request para la página de about [04:30]. Te entrega:

• Una definición en código con su type y su namespace.
• Los métodos que utiliza y ejemplos de uso que no estaban en el archivo.
• Notas y recomendaciones para seguir explorando, como el Home Controller o el Post Controller.

Lo valioso es que se trata de un repo desconocido hasta ese momento, y aun así puedes entender cómo funciona leyendo documentación generada en tiempo real.

¿Puedo documentar un proyecto completo con Deep Wiki? Sí. Haces clic en cada función, eliges copiar artículo y lo llevas a un Confluence. En poco tiempo tienes la documentación entera disponible y compartible.

¿Cuándo documentar y cuándo solo pasar el link del repo?

Aquí hay una decisión práctica según tu equipo. Si necesitas que el equipo crezca, documenta con copiar artículo y centraliza todo en Confluence.

Pero si eso no es necesario, basta con pasarle el link del repositorio a otra persona y explicarle cómo leerlo con Windsurf usando Deep Wiki. Así evitas trabajo manual que nadie disfruta.

Yo le veo muchísimo potencial a esta función. Úsala y cuéntame en los comentarios si te gusta tanto como a mí.