CodeGuide

Was ist CodeGuide?

CodeGuide ist ein spec-basierter Kontextgenerator für AI-Coding-Tools. Es hilft, eine Idee oder einen bestehenden GitHub-Codebase in strukturierte Projektdokumente umzuwandeln – wie PRDs, technische Spezifikationen und Wireframes –, die AI-Modelle beim Implementieren von Software referenzieren können.

Der Kernzweck ist es, das „Black-Box“-Problem in der AI-unterstützten Entwicklung zu reduzieren, indem eine Projektwissensbasis mit klarerem Kontext für Planung und Dokumentation erstellt wird – egal ob aus einer Beschreibung gestartet oder ein Legacy-Repository erweitert wird.

Wichtige Funktionen

• Spec-basierte Dokumentenerstellung (Eingabe in einfachem Englisch): Beschreiben Sie Ihr Projekt in einfachem Englisch, um ein Dokumentationskit zu generieren, inklusive PRDs, Tech-Stack-Anleitungen und Wireframes.
• Dokumentation bestehender GitHub-Codebases: Füttern Sie bestehende GitHub-Projekte, um die Codebase zu kartieren, damit AI-Tools klareren Kontext über den Repository-Inhalt haben.
• AI-Dokumentations-Workflow (Klärfragen → Plan → Docs): Geben Sie eine Projektbeschreibung und beantworten Sie offene Fragen (z. B. zu Benachrichtigungsverhalten, Onboarding, Feature-Einschränkungen), um die resultierenden Docs zu formen.
• Software v2 autonomer Coding-Agent: Nutzen Sie einen Agenten, der eine Codebase analysieren, Dokumentation planen und Coding-Aufgaben „autonom“ für längere Sessions ausführen kann.
• Einheitliche Oberfläche für mehrere CLI-Tools / Model-Routing: Bedienen Sie mit einer einzigen Oberfläche, während mehrere AI-Modelle synchron arbeiten; ein Model-Router wählt Modelle für verschiedene Workflow-Teile aus.
• Chrome-Erweiterung für browserbasierte Generierung: Generieren Sie PRDs, Tech-Specs und Dokumentation direkt im Browser.
• On-Screen-UI-Editor: Bearbeiten Sie on-screen und koordinieren Sie mehrere Agenten parallel für UI-Reparaturen oder Feature-Erweiterungen.
• Starter-Kits zur Reduzierung des Setup-Aufwands: Open-Source-Boilerplates für AI-Coding-Modelle enthalten gängige Infrastruktur wie Authentifizierung, Datenbankkonfiguration und Stripe-Zahlungskonfiguration (wie in den Templates beschrieben).

So verwenden Sie CodeGuide

1. Mit einer Idee oder einem Repo starten: Beschreiben Sie in einfachem Englisch, was Sie bauen wollen, oder weisen Sie CodeGuide auf ein bestehendes GitHub-Projekt hin.
2. Projektfragen bei Aufforderung beantworten: Nutzen Sie die Klärfragen, um Produktverhalten und Einschränkungen zu spezifizieren.
3. Das Dokumentationskit generieren: Erzeugen Sie die für die Implementierung benötigten Outputs wie PRDs, Tech-Specs, Wireframes und zugehörige Planungsartefakte.
4. Software v2 für die Ausführung nutzen: Wenn Sie zur Coding- und Implementierungsphase übergehen, starten Sie den autonomen Agenten, um die Codebase zu analysieren und der geplanten Dokumentation zu folgen.
5. Optional die Chrome-Erweiterung verwenden: Generieren Sie PRDs/Tech-Specs/Dokumentation innerhalb Ihres Browser-Workflows.

Anwendungsfälle

• Eine App-Idee in implementierungsreife Specs umwandeln: Ein Entwickler beschreibt ein App-Konzept (z. B. Mobile-App vs. Website) und beantwortet Fragen zum Produktverhalten, um PRDs, Tech-Specs und Wireframes zu erhalten.
• Ein Legacy-GitHub-Repository für AI-Entwicklung dokumentieren: Bei älterem, schwer interpretierbarem Code das Repository füttern, um einen kartierten, AI-verwendbaren Kontext für nachfolgende Coding-Aufgaben zu bekommen.
• Produktanforderungen vor Einsatz eines AI-Coding-Assistenten planen: Generierte Specs als strukturierte Eingabe nutzen, damit ein AI-Coding-Tool Features auf Basis expliziter Anforderungen statt ad-hoc Prompts implementiert.
• Autonome Coding-Arbeit mit einem Agenten durchführen: Software v2 nutzen, um Codebase-Analyse, Planung und Coding-Ausführung über längere Sessions mit einheitlicher Oberfläche zu koordinieren.
• UI iterativ verbessern oder erweitern: Den On-Screen-Editor nutzen, um UI-Probleme zu korrigieren oder Features hinzuzufügen, während mehrere Agenten parallel arbeiten.

FAQ

Erstellt CodeGuide Dokumentation aus einer Beschreibung, einem Repository oder beidem?

CodeGuide unterstützt beides: Es kann Docs aus einer Idee in einfachem Englisch generieren und Dokumentation für bestehende GitHub-Codebases, indem es das Repository für den AI-Kontext abbildet.

Welche Arten von Dokumenten kann CodeGuide erstellen?

Die Seite beschreibt PRDs, Tech-Spezifikationen und Wireframes als zentrale Ausgaben sowie ein umfassenderes „Documentation Kit“, das an Ihr Projektbrief gebunden ist.

Was ist Software v2?

Software v2 wird als autonomer Coding-Agent beschrieben, der Codebases analysieren, Dokumentation planen und Code ausführen kann, mit einheitlicher Oberfläche und synchronisierten Modellen.

Wie hilft das Produkt gegen AI-Halluzinationen?

Die Seite rahmt den Ansatz als Erstellung einer Projekt-Wissensbasis und strukturierter Specs/Kontexte ab, auf die AI-Modelle verweisen können, um „Raten“ durch fehlenden oder unklaren Kontext zu reduzieren.

Gibt es Tools, um CodeGuide außerhalb der Haupt-App zu nutzen?

Ja. Die Seite erwähnt eine Chrome-Erweiterung zum Generieren von PRDs, Tech-Spezifikationen und Dokumentation direkt im Browser.

Alternativen

• Manuelles Schreiben von PRDs/Tech-Specs plus AI-Coding-Assistent: Dokumentation selbst (oder mit einem allgemeinen AI-Chat) schreiben und dann an ein Coding-Tool weitergeben; unterscheidet sich durch Abhängigkeit von nutzererstellten Specs statt Repository-Mapping und strukturiertem Generierungs-Workflow.
• Allgemeine AI-Coding-Copilots: Tools, die auf Code-Generierung und Refactoring fokussieren, bieten möglicherweise nicht dasselbe End-to-End-Documentation-Kit (PRDs/Tech-Specs/Wireframes) oder Repository-Mapping wie hier beschrieben.
• Dokumentations-fokussierte Codebase-Analyse-Tools: Ansätze, die Dokumentation aus Quellcode generieren (ohne Spec/PRD-Workflow), können das Verständnis fördern, erzeugen aber möglicherweise nicht dieselben Planungsartefakte, die an Produktanforderungen gebunden sind.
• Starter-Templates/Boilerplates mit separater Planung: Boilerplates können Setup-Zeit reduzieren, erfordern aber einen separaten Prozess, um PRDs/Tech-Specs und Wireframes für AI-Coding-Workflows zu generieren.