Prompts Maestros logo
Prompts Workflows PRO

Prompt para Documentar un Fragmento de Código de Forma Clara y Profesional

Genera documentación precisa, legible y técnica que explique paso a paso qué hace un bloque de código y cómo funciona.

Este prompt permite documentar fragmentos de código con precisión, claridad técnica y estructura profesional. La versión gratuita explica el propósito y las partes esenciales, mientras que la versión extendida añade análisis profundo, riesgos, complejidad, código comentado y recomendaciones de refactorización.

Ideal para revisiones de código, auditorías técnicas, PRs, documentación interna o procesos de onboarding.

Actúa como un ingeniero de software especializado en documentación técnica. Documenta el siguiente fragmento de código y explica su funcionamiento de manera clara. # INFORMACIÓN DEL USUARIO: - Lenguaje del código: [LENGUAJE] - Fragmento de código: [CODIGO] - Contexto breve o funcionalidad general: [CONTEXTO] Devuelve: 1. Propósito del código. 2. Explicación línea por línea o bloque por bloque. 3. Entradas, salidas y efectos secundarios. 4. Observaciones importantes para mantenimiento.
# CONTEXTO: Eres un ingeniero senior especializado en diseño, análisis y documentación de código limpio. Tu misión es documentar a nivel profesional un fragmento de código concreto, explicando cada parte con precisión técnica y proponiendo mejoras objetivas. # INFORMACIÓN DEL USUARIO: - Lenguaje del código: [LENGUAJE] - Código completo a documentar: [CODIGO] - Contexto o módulo donde se encuentra: [MODULO] - Estándar de estilo deseado: [ESTILO] - Objetivo principal de la documentación (onboarding, auditoría, refactorización, etc.): [OBJETIVO] # BLOQUES DE RESPUESTA: ## 1. Propósito y Alcance Explicación completa del objetivo del código y su rol dentro del sistema. ## 2. Flujo Detallado del Código Descripción técnica bloque por bloque, explicando variables, funciones, condiciones, estructuras y efectos. ## 3. Dependencias y Supuestos Librerías usadas, entorno esperado, tipos esperados, casos límite. ## 4. Complejidad y Riesgos Técnicos Observaciones sobre rendimiento, seguridad, escalabilidad o mantenibilidad. ## 5. Versión Comentada del Código Código original reescrito incluyendo comentarios profesionales según [ESTILO]. ## 6. Recomendaciones de Mejora Sugerencias de refactorización, modularización, naming o patrones recomendados. # CRITERIOS DE CALIDAD: - Claridad técnica y precisión en conceptos. - Comentarios útiles y no redundantes. - Explicaciones alineadas a buenas prácticas del lenguaje. - Sugerencias realistas y con impacto.
Este prompt pertenece a la categoría de Programación y Código

¿Qué hace el prompt?

Versión Básica

  • Explica de forma clara el propósito del fragmento de código.
  • Describe cada parte relevante con lenguaje técnico sencillo.
  • Aclara entradas, salidas y efectos secundarios.
  • Identifica supuestos lógicos o dependencias inmediatas.

Versión Extendida

  • Explica de forma clara el propósito del fragmento de código.
  • Describe cada parte relevante con lenguaje técnico sencillo.
  • Aclara entradas, salidas y efectos secundarios.
  • Identifica supuestos lógicos o dependencias inmediatas.
  • Documenta el fragmento con detalle técnico profesional.
  • Analiza su flujo, dependencias y estructura lógica.
  • Evalúa complejidad, riesgos y posibles puntos de fallo.
  • Sugiere mejoras de estilo, legibilidad y rendimiento.
  • Genera una versión comentada siguiendo buenas prácticas del lenguaje.

¿Cómo usar este prompt?

Versión Básica

  • Completa las variables con tus datos reales:
  • [LENGUAJE] Ej.: 'JavaScript', 'Python', 'Go'.
  • [CODIGO] Pega el fragmento completo.
  • [CONTEXTO] Ej.: 'valida usuarios', 'procesa un pago', 'filtra datos'.
  • Úsalo como documentación rápida para onboardings, PRs o auditorías.

Versión Extendida

  • Completa las variables con tu contexto real:
  • [LENGUAJE] El lenguaje del fragmento.
  • [CODIGO] Pega el código completo.
  • [MODULO] Ej.: 'servicio de pagos', 'controlador de usuarios'.
  • [ESTILO] Ej.: 'PEP8', 'Airbnb JS Style', 'Google Java Style'.
  • [OBJETIVO] Ej.: 'onboarding del equipo', 'auditoría externa', 'refactor'.
  • Ejecuta para obtener documentación técnica profesional y sugerencias avanzadas.

Tips

Versión Básica

  • Incluye el bloque de código completo sin recortes.
  • Indica siempre el lenguaje de programación del fragmento.
  • Aclara el contexto: qué hace, dónde vive y qué espera recibir.
  • Si usas librerías externas, menciona su nombre para mejor precisión.

Versión Extendida

  • Indica el estándar de estilo que usas (PEP8, ESLint, Google Java Style).
  • Aclara si deseas recomendaciones de seguridad, rendimiento o arquitectura.
  • Puedes pedir que la salida incluya métricas de complejidad.
  • Incluye contexto sobre el módulo donde vive este fragmento.