Prompts Maestros logo
Prompts Workflows PRO

Prompt para Documentar la Arquitectura y Diseño de un Sistema

Genera documentación clara, técnica y estructurada que describa la arquitectura, componentes y diseño de un proyecto en cualquier lenguaje.

Este prompt permite generar documentación técnica clara, útil y bien estructurada sobre arquitectura de software. La versión gratuita ofrece un resumen funcional del sistema, mientras que la versión extendida aporta un análisis arquitectónico completo con decisiones de diseño, diagramas textuales y recomendaciones de escalabilidad.

Ideal para onboarding de desarrolladores, auditorías técnicas, presentación de sistemas o documentación interna de proyectos.

Actúa como un documentador técnico especializado en arquitectura de software. Crea una descripción general clara y concisa de la arquitectura del siguiente proyecto. # INFORMACIÓN DEL USUARIO: - Lenguaje o stack principal: [IDIOMA] - Descripción del proyecto: [DESCRIPCION_PROYECTO] Devuelve: 1. Resumen de arquitectura. 2. Componentes principales con funciones claras. 3. Flujo general del sistema. 4. Notas breves sobre decisiones de diseño relevantes.
# CONTEXTO: Eres un arquitecto de software senior especializado en documentación técnica y diseño de sistemas. Tu tarea es describir de forma exhaustiva la arquitectura del proyecto, sus patrones, componentes, flujos y decisiones técnicas. # INFORMACIÓN DEL USUARIO: - Lenguaje o stack del sistema: [IDIOMA] - Descripción completa del proyecto: [DESCRIPCION_PROYECTO] - Tipo de arquitectura (monolito, modular, microservicios, etc.): [ARQUITECTURA] - Requerimientos no funcionales relevantes (performance, seguridad, disponibilidad, etc.): [RNF] # BLOQUES DE RESPUESTA: ## 1. Visión General del Sistema Descripción completa del propósito, alcance y contexto de negocio. ## 2. Arquitectura y Componentes Explicación de capas, módulos, responsabilidades, patrones aplicados y dependencias. ## 3. Diagramas en Texto - Diagrama de componentes. - Diagrama de flujo o secuencia. - Mapeo de entrada → procesamiento → salida. ## 4. Decisiones de Diseño (ADRs simplificados) Explica por qué se eligieron tecnologías, patrones y estructuras. ## 5. Riesgos Técnicos y Puntos de Falla Incluye análisis de posibles cuellos de botella, dependencias externas y mitigaciones. ## 6. Recomendaciones de Escalabilidad y Mantenibilidad Sugerencias prácticas basadas en mejores prácticas del stack. # CRITERIOS DE CALIDAD: - Claridad técnica sin sobrecargar con jerga innecesaria. - Explicaciones con enfoque en arquitectura, diseño y mantenibilidad. - Contenido útil para onboarding, auditoría técnica o toma de decisiones.
Este prompt pertenece a la categoría de Programación y Código

¿Qué hace el prompt?

Versión Básica

  • Genera una descripción general de la arquitectura del sistema.
  • Resume los componentes principales y su función en el proyecto.
  • Explica de forma sencilla el flujo general de datos o ejecución.
  • Proporciona un esquema básico fácil de entender para nuevos desarrolladores.

Versión Extendida

  • Genera una descripción general de la arquitectura del sistema.
  • Resume los componentes principales y su función en el proyecto.
  • Explica de forma sencilla el flujo general de datos o ejecución.
  • Proporciona un esquema básico fácil de entender para nuevos desarrolladores.
  • Genera documentación técnica detallada de arquitectura, capas y patrones utilizados.
  • Incluye diagramas explicados en texto (componentes, secuencia, flujo de datos).
  • Explica decisiones arquitectónicas clave y su justificación.
  • Analiza riesgos técnicos, dependencias críticas y puntos de fallo.
  • Sugiere mejoras de escalabilidad, seguridad y mantenibilidad.

¿Cómo usar este prompt?

Versión Básica

  • Completa las variables con tu contexto técnico:
  • [IDIOMA] Ej.: 'Node.js', 'Python', 'React + Express', 'Java Spring'.
  • [DESCRIPCION_PROYECTO] Ej.: 'API REST para facturación con microservicios'.
  • Úsalo como base de documentación para onboarding, auditorías o mantenimiento interno.

Versión Extendida

  • Completa las variables:
  • [IDIOMA] Ej.: 'Go + PostgreSQL', 'Python FastAPI', 'Next.js + Supabase'.
  • [DESCRIPCION_PROYECTO] Explica brevemente qué hace el sistema.
  • [ARQUITECTURA] Ej.: 'microservicios', 'monolito modular', 'serverless'.
  • [RNF] Ej.: '99.9% uptime, respuesta < 200 ms, cifrado en tránsito'.
  • Ejecuta el prompt para obtener documentación técnica sólida y lista para compartir.

Tips

Versión Básica

  • Especifica siempre el lenguaje o stack tecnológico del proyecto.
  • Incluye una descripción clara del sistema o módulo para una documentación más precisa.
  • Si existe un diagrama previo, menciona sus elementos clave.
  • Indica si la documentación se usará para onboarding, auditoría o mantenimiento.

Versión Extendida

  • Indica si el sistema es monolítico, modular o basado en microservicios.
  • Incluye requerimientos no funcionales (rendimiento, seguridad, disponibilidad).
  • Aclara si deseas documentación orientada a desarrolladores, clientes o auditores.
  • Puedes pedir una versión más técnica o más ejecutiva según el destinatario.