Para programar correctamente con las herramientas AI IDE, es necesario elaborar un conjunto de documentos de especificaciones y declaraciones detalladas de requisitos.

Como un niño que es listo pero no entiende las mejores prácticas de código.

Tienes que decirle claramente a la IA lo que quieres:

  • ¿Es una aplicación web?
  • ¿Qué características se necesitan?
  • ¿Cuál es la estructura?
    Y así sucesivamente.

He aquí cómo hacer de la IA tu desarrollador full-stack:

正确使用AI IDE工具编程,你需要构造一套规范文档和详细需求说明

 

El contexto es crucial.

Se necesita una fuerte barrera contextual para la IA.

Objetivo: No dejes que la IA haga suposiciones. Toda la información la proporcionas tú.

De este modo, la IA trabajará contigo, no contra ti.

A continuación se analiza qué documentación debe adjuntarse para ofrecer el máximo apoyo contextual.

正确使用AI IDE工具编程,你需要构造一套规范文档和详细需求说明

 

1. Documento de requisitos del proyecto

Este documento describe el proyecto en su conjunto:

  • Perfil del proyecto
  • Planteamiento del problema
  • prescripción
  • usuario objetivo
  • pila tecnológica
  • funcionalidad básica
  • Alcance del trabajo

Este documento es una breve descripción de su proyecto.

A continuación, añada documentación más específica para guiar a la IA en cada paso.

 

2. Documentación de procesos y funcionalidades de la aplicación

Imagina que estás explicando tu aplicación a un amigo:

"Cuando un usuario se registra, salta al panel de control. En el panel hay 4 secciones: sección de métricas, sección de análisis, etc.".

Este documento proporciona el flujo completo de la aplicación de principio a fin.

llamar la atención sobre algoSe solicita a AI que incluya en el documento No utilice balas.

Este documento es importante porque proporciona a la IA un diagrama/blueprint para planificar la ejecución de cada página.

 

3. Documentación sobre pilas tecnológicas y paquetes de dependencias

Ahora proporcionamos los antecedentes técnicos de la IA.

¿Su proyecto utiliza Python? o Nextjs? Supabase o Firebase para el backend?

Este documento detallará la pila tecnológica que AI necesita utilizar para construir su aplicación.

Asegúrese de elegir una pila tecnológica de uso común, porque cosas como Claude y los LLM como GPT-4 se entrenan principalmente basándose en marcos ampliamente utilizados.

Estoy usando Nextjs 14, TaliwindCSS, shadcnUI y radixUI para el frontend y Supabase para el backend.

Todas las plataformas siguientes prefieren esta pila tecnológica:

Python también es ideal para aplicaciones de alto rendimiento que no requieren una interfaz de usuario moderna.

 

4. Documentación de la estructura del documento

Este documento es vital si no quieres entrar en un círculo vicioso de errores constantes.

La IA puede crear archivos duplicados, guardar archivos en la ubicación incorrecta o incluso borrar código terminado.

Para resolver este problema, facilite por adelantado la estructura del documento.

llamar la atención sobre algo: Asegúrese de que la IA debe crear la estructura del archivo en formato ASCII.

Haga una captura de pantalla para guardar la estructura del archivo y adjúntela al documento.

 

5. Documentación de la API

La IA no sabe por defecto cómo están configuradas las API de ninguna plataforma.

Necesitamos adjuntar documentación para todas las APIs que se utilizarán en la aplicación.

Algunos ejemplos son la API de OpenAI, la documentación de la API de Claude, la documentación de Supabase, etc.

Copia las instrucciones de su sitio web y pégalas en tu documento, luego adjunta ese documento a la IA.

 

6. Documentación de diseño de la arquitectura de back-end

La arquitectura es básicamente el proyecto de back-end.

Contiene todas las tablas de la base de datos, los buckets de almacenamiento y las tablas de información de usuario (autenticación) que deben crearse.

Utilizo Supabase porque la IA es capaz de generar consultas SQL que puedes ejecutar directamente en Supabase en cuestión de segundos.

De este modo, puedo crear mi base de datos y adjuntarla al front-end en menos de una hora.

punto brillante: Claude es excelente diseñando arquitecturas de back-end, y si creas la documentación adecuada, la IA seguirá fácilmente las directrices.

 

7. archivo .cursorrules

Mucha gente no utiliza esta herramienta. Es similar a ChatGPT de comandos personalizados.

El archivo .cursorrules tiene que ser específico del proyecto en lugar de un aviso genérico de "reglas AI".

Basándose en la pila tecnológica y en los requisitos del proyecto, se pide a la IA que cree un archivo .cursorrules.

Este documento indicará a la IA dónde se encuentra cada documento (mapa de navegación del Cursor).

Ayuda a la IA a navegar de forma más eficiente con este archivo.

 

8. Documentación sobre el diseño de la interfaz de usuario

Este documento hará que su interfaz de usuario sea más agradable estéticamente. Cuando se utiliza con v0, crea componentes frontales con un estilo coherente.

La mayoría de la gente subestima el poder de una interfaz de usuario limpia.

"La primera impresión es la que cuenta".

Este documento debe contener la siguiente información: paquetes de interfaz de usuario utilizados, fuentes, esquemas de color, iconos, efectos, etc.

 

9. Indicaciones del sistema

Se puede pedir a la IA que cree palabras de aviso del sistema específicas del proyecto para v0, bolt o cualquier herramienta que pueda utilizar.

Esto ayuda a comunicarse con la herramienta y elimina la necesidad de proporcionar un contexto más largo cada vez.

¿Sabes por qué Claude funciona mejor en su plataforma que a través de la API? Porque sus señales del sistema son excelentes.

Haz lo mismo con tu proyecto y te harás más amigo de la IA.

Dediqué 80% de mi tiempo de desarrollo a crear la documentación y conseguí grandes resultados en los 20% restantes.

 

Introducción: codeguide.dev

Una aplicación que te ayuda a aportar ideas y redactar todos los documentos importantes para adjuntar a la IA.

✅ Palabra de alerta del sistema
✅ Documento PRD
✅ Diseño arquitectónico
✅ Documentación del proceso de solicitud
✅ Documentación sobre el diseño de la interfaz de usuario
¡Un momento!

 

enlace (en un sitio web)::http://codeguide.dev

© declaración de copyright

Artículos relacionados

Sin comentarios

Debe iniciar sesión para participar en los comentarios.
Acceder ahora
ninguno
Sin comentarios...