Wie ein Kind, das zwar schlau ist, aber die besten Praktiken des Codes nicht versteht.
Sie müssen der KI klar sagen, was Sie wollen:
- Handelt es sich um eine Webanwendung?
- Welche Funktionen werden benötigt?
- Wie ist die Struktur?
Und so weiter.
Hier erfahren Sie, wie Sie AI zu Ihrem vollwertigen Entwickler machen:
Der Kontext ist entscheidend!
Sie brauchen eine starke kontextuelle Barriere für KI.
Ziel: Lassen Sie die KI keine Annahmen treffen. Alle Informationen werden von Ihnen bereitgestellt.
Auf diese Weise arbeitet die KI mit Ihnen und nicht gegen Sie.
Als Nächstes wird erörtert, welche Unterlagen beigefügt werden müssen, um ein Höchstmaß an kontextbezogener Unterstützung zu bieten.
1. das Projektanforderungsdokument
In diesem Dokument wird das Projekt als Ganzes beschrieben:
- Projektprofil
- Beschreibung des Problems
- Verschreibung
- Zielbenutzer
- Technologiepaket
- Kernfunktionalität
- Umfang der Arbeiten
Dieses Dokument ist eine kurze Beschreibung Ihres Projekts.
Fügen Sie als Nächstes eine spezifischere Dokumentation hinzu, um die KI durch die einzelnen Schritte zu führen.
2. die Dokumentation der Anwendungsprozesse und -funktionen
Stellen Sie sich vor, Sie erläutern einem Freund Ihre App:
"Wenn sich ein Benutzer registriert, springt er zum Dashboard. Auf dem Dashboard gibt es 4 Bereiche: Metriken, Analysen, usw."
Dieses Dokument enthält den vollständigen End-to-End-Laufzeitablauf der Anwendung.
auf etw. aufmerksam machenAI wird gebeten, in das Dokument aufzunehmen Keine Kugeln verwenden.
Dieses Dokument ist wichtig, weil es der KI ein Diagramm/Blaupause für die Planung der Ausführung jeder Seite liefert.
3. die Dokumentation des Technologiestapels und des Abhängigkeitspakets
Jetzt wird der technische Hintergrund für KI geliefert.
Verwendet Ihr Projekt Python? oder Nextjs? Supabase oder Firebase für das Backend?
In diesem Dokument wird der Technologie-Stack beschrieben, den AI für die Erstellung Ihrer Anwendung verwenden muss.
Achten Sie darauf, dass Sie einen häufig verwendeten Tech-Stack wählen, denn Dinge wie Claude und LLMs wie GPT-4 werden in erster Linie auf der Grundlage weit verbreiteter Rahmenwerke ausgebildet.
Ich verwende Nextjs 14, TaliwindCSS, shadcnUI und radixUI für das Frontend und Supabase für das Backend.
Die folgenden Plattformen bevorzugen alle dieses Technologiepaket:
Python eignet sich auch hervorragend für Hochleistungsanwendungen, die keine moderne Benutzeroberfläche erfordern.
4. die Dokumentation der Struktur des Dokuments
Dieses Dokument ist unerlässlich, wenn Sie nicht in einen Teufelskreis von ständigen Fehlern geraten wollen.
Die KI kann doppelte Dateien erstellen, Dateien am falschen Ort speichern oder sogar fertigen Code löschen.
Um dieses Problem zu lösen, stellen Sie bitte die Struktur des Dokuments im Voraus bereit.
auf etw. aufmerksam machenVergewissern Sie sich, dass die AI erforderlich ist, um die Dateistruktur im ASCII-Format zu erstellen.
Machen Sie einen Screenshot, um die Dateistruktur zu speichern und fügen Sie ihn dem Dokument bei.
5) API-Dokumentation
Die KI weiß standardmäßig nicht, wie die APIs einer Plattform konfiguriert sind.
Wir müssen die Dokumentation für alle APIs, die in der Anwendung verwendet werden, anhängen.
Beispiele sind die OpenAI API, die Claude API-Dokumentation, die Supabase-Dokumentation usw.
Kopieren Sie die Anweisungen von der Website, fügen Sie sie in Ihr Dokument ein und fügen Sie dieses Dokument an das AI an.
6. die Dokumentation des Entwurfs der Backend-Architektur
Die Architektur ist im Grunde Ihr Backend-Entwurf.
Sie enthält alle Datenbanktabellen, Speicherbereiche und Benutzerinformationstabellen (Authentifizierung), die erstellt werden müssen.
Ich verwende Supabase, weil die KI in der Lage ist, SQL-Abfragen zu erstellen, die Sie in Sekundenschnelle direkt in Supabase ausführen können.
Auf diese Weise kann ich meine Datenbank in weniger als einer Stunde erstellen und mit dem Frontend verbinden.
LichtblickClaude eignet sich hervorragend für die Entwicklung von Back-End-Architekturen, und wenn Sie die richtige Dokumentation erstellen, wird die KI der Anleitung leicht folgen.
7. die Datei .cursorrules
Viele Menschen nutzen dieses Instrument nicht. Es ist ähnlich wie ChatGPT von benutzerdefinierten Befehlen.
Die .cursorrules-Datei muss projektspezifisch sein und darf keine allgemeine "AI-Regeln"-Eingabeaufforderung enthalten.
Je nach Technologie-Stack und Projektanforderungen wird die KI aufgefordert, eine .cursorrules-Datei zu erstellen.
In diesem Dokument wird der KI mitgeteilt, wo sich die einzelnen Dokumente befinden (Navigationskarte des Cursors).
Helfen Sie AI mit dieser Datei, effizienter zu navigieren.
8. die Dokumentation des UI-Layouts
Dieses Dokument wird Ihre Front-End-Schnittstelle ästhetisch ansprechender gestalten. Bei Verwendung mit v0 erstellt es Frontend-Komponenten mit einem einheitlichen Stil.
Die meisten Menschen unterschätzen die Macht einer sauberen Benutzeroberfläche (UI).
"Der erste Eindruck zählt."
Dieses Dokument sollte die folgenden Informationen enthalten: verwendete UI-Pakete, Schriftarten, Farbschemata, Symbole, Effekte usw.
9. systembedingte Hinweise
Die KI kann aufgefordert werden, projektspezifische Systempromptwörter für v0, bolt oder jedes andere von Ihnen verwendete Tool zu erstellen.
Dies erleichtert die Kommunikation mit dem Tool und macht es überflüssig, jedes Mal einen längeren Kontext anzugeben.
Wissen Sie, warum Claude auf ihrer Plattform besser abschneidet als bei der Verwendung von APIs? Das liegt daran, dass ihre Systemhinweise hervorragend sind.
Tun Sie dasselbe für Ihr Projekt, und Sie werden sich mit KI besser anfreunden können.
Ich habe 80% meiner Entwicklungszeit mit der Erstellung der Dokumentation verbracht und in den restlichen 20% großartige Ergebnisse erzielt.
Einführung: codeguide.dev
Eine App, die Ihnen beim Brainstorming und Schreiben aller wichtigen Dokumente hilft, die Sie an AI anhängen können.
✅ System-Warnwort
✅ PRD-Dokument
✅ Architektur Design
✅ Dokumentation des Antragsverfahrens
✅ Dokumentation des UI-Layouts
Moment mal!
Link (auf einer Website)::http://codeguide.dev
