Fortgeschrittenes Praxisszenario · Szenario 2

Sich schnell mit dem Projekt eines neuen Unternehmens vertraut machen

Beherrschen Sie eine systematische Methode, um neue Projekte schnell zu verstehen – vom Lesen des Codes bis zum Projektverständnis, vom schnellen Einstieg bis zur Wissenssicherung. Nutzen Sie KI-Tools, um das Lesen und Verstehen von Code zu beschleunigen und sich schnell in ein neues Team einzuarbeiten.

Lernziele

Eine systematische Methode meistern, um neue Projekte schnell zu verstehen

Kann KI-Tools nutzen, um das Lesen und Verstehen von Code zu beschleunigen

Verfügt über die Fähigkeit, Wissen aufzubauen und zu teilen

Das Framework zum Projektverständnis verstehen (Geschäftsverständnis → Architekturverständnis → Codeverständnis)

Methodik

Strategie zum Lesen von Code

Top-down (Top-Down)

• Anwendungsszenarien: Erfordert ein schnelles Verständnis der Gesamtarchitektur und der Geschäftsabläufe
• Lesereihenfolge: README → Architekturdokumentation → Einstiegdatei → Hauptmodule → konkrete Implementierung
• Vorteile：Sich schnell ein Gesamtbild verschaffen und die Geschäftslogik verstehen

Bottom-up (Bottom-Up)

• Anwendungsszenarien: Es ist erforderlich, eine bestimmte Funktion oder ein bestimmtes Modul tiefgehend zu verstehen
• Lesereihenfolge: konkrete Implementierung → Modulschnittstellen → Modulabhängigkeiten → Gesamtarchitektur
• Vorteile：Die Implementierungsdetails tiefgehend verstehen und die technischen Feinheiten beherrschen

Anwendung von KI-Tools: Verwenden Sie Windsurfs Fast Context oder Cursor Agent, um die Gesamtstruktur und die wichtigsten Module einer großen Codebasis schnell zu verstehen.

Rahmenwerk zum Projektverständnis

Geschäftsverständnis: Geschäftsziele, Nutzerbedürfnisse, Geschäftsprozesse und Geschäftsregeln verstehen

• Produktdokumentation, Anforderungsdokumente und User Stories lesen
• Geschäftsmodelle und Datenmodelle verstehen
• KI-Tools verwenden: NotebookLM zum Organisieren von Geschäftsdokumenten

Architekturverständnis：Systemarchitektur, Modulaufteilung, Tech-Stack und Datenfluss verstehen

• Architektur- und technische Dokumente lesen
• Modulabhängigkeiten und Datenfluss verstehen
• Verwendung von KI-Tools: Windsurf analysiert die Codestruktur, Cursor Agent erstellt Architekturdiagramme

Codeverständnis: Codestruktur, zentrale Implementierungen, Entwurfsmuster und Best Practices verstehen

• Schlüsselcode lesen und die Implementierungslogik verstehen
• Code-Stil und Designmuster verstehen
• KI-Tools verwenden: Cursor Agent Code-Q&A, Zread Code-Analyse

Schnellstart-Workflow

Phase 1: Dokumentenlesen (1–2 Tage)

• README, Architektur-Dokumente und API-Dokumente lesen
• Projektziele, Tech-Stack und Entwicklungsprozess verstehen
• KI-Tools verwenden: NotebookLM zum Organisieren von Dokumenten, Fabric zum Erstellen von Zusammenfassungen

Phase 2: Code-Erkundung (2–3 Tage)

• Das Projekt ausführen und den Startablauf verstehen
• Die Schlüsselmodule erkunden und die Code-Struktur verstehen
• KI-Tools verwenden: Windsurf für schnelles Verständnis, Cursor Agent für Code-Q&A

Phase 3: Entwicklung kleiner Funktionen (3–5 Tage)

• Wähle eine kleine Funktion zur Entwicklung aus
• Den Entwicklungsprozess, die Codekonventionen und die Testanforderungen verstehen
• KI-Tools verwenden: Cursor Agent zur Entwicklungsunterstützung und Codeüberprüfung

Phase 4: Refactoring-Optimierung (laufend)

• Codeprobleme erkennen und Optimierungsvorschläge machen
• Code refaktorisieren, um die Codequalität zu verbessern
• KI-Tools verwenden: Codeoptimierung mit Cursor Agent, Refactoring-Vorschläge

Methoden zur Wissensakkumulation

Notizen und Dokumente

• Lernnotizen: wichtige Konzepte, Architekturen und Code-Muster festhalten
• Problemlog：Die aufgetretenen Probleme und Lösungen festhalten
• Best Practices: Die Best Practices und Designmuster im Projekt zusammenfassen

Erstellung von Skill/Pattern

• Cursor Skill：projektspezifische Entwicklungsmuster als Skill kapseln
• Fabric Pattern: gängige Code-Muster als Patterns kapseln
• Team-Sharing：Skills und Patterns können im Team geteilt und wiederverwendet werden

Wissensaustausch

• Technischer Austausch: Lernenserkenntnisse und Best Practices im Team teilen
• Dokumentaktualisierung: Die Projektdokumentation aktualisieren und fehlende Informationen ergänzen
• Code-Review: Wissen durch Code-Reviews lernen und teilen

Anwendung von KI-Tools

Mit Windsurfs Fast Context große Codebasen schnell verstehen

Die Fast-Context-Technologie von Windsurf kann große Codebasen schnell analysieren und die Gesamtstruktur verstehen:

• Schnellindex: die gesamte Codebasis automatisch indizieren und eine Codekarte erstellen
• Intelligente Suche：verwandten Code und Dateien schnell durchsuchen
• Kontextverständnis：Die Abhängigkeiten und den Datenfluss zwischen Code verstehen
• Architekturanalyse: Systemarchitektur und Modulaufteilung automatisch analysieren

Cursor Agent für Codeerkundung und Q&A verwenden

Verwenden Sie den Agent-Modus von Cursor, um den Code im Frage-und-Antwort-Format zu verstehen:

Beispielfrage:

• „Was macht diese Funktion?“
• „Von welchen anderen Modulen hängt dieses Modul ab?“
• "Wie fließen Daten von der API zur UI?"
• „Was ist dieses Entwurfsmuster? Warum ist es so gestaltet?“

• Die KI analysiert den Code und beantwortet Ihre Fragen
• Sie können detailliert nachfragen und Implementierungsdetails verstehen
• Codekommentare und Dokumentation generieren

Verwenden Sie Zread, um GitHub-Repositorys zu analysieren

Zread kann GitHub-Repositories schnell analysieren und die Projektstruktur verstehen:

• Repository-Übersicht：Projektstruktur, Tech-Stack und Abhängigkeiten schnell erfassen
• Codeanalyse: Codequalität, Komplexität und Entwurfsmuster analysieren
• Commit-Historie：die Entwicklungsgeschichte des Projekts und die wichtigsten Änderungen verstehen
• Problemerkennung：Potenzielle Probleme und Verbesserungsmöglichkeiten identifizieren

NotebookLM für die Dokumentenorganisation und Wissensextraktion verwenden

NotebookLM kann Projektdokumente organisieren und wichtige Informationen extrahieren:

• Dokumentenimport: README-, Architektur- und API-Dokumentation importieren
• Wissensextraktion: Wichtige Konzepte, Architekturdesign und API-Schnittstellen automatisch extrahieren
• Q&A-System: Fragen auf Grundlage des Dokumentinhalts beantworten
• Wissenszusammenfassung: Projektübersicht und Wissensgraph generieren

Fabric zur Generierung von Codezusammenfassungen verwenden

Verwenden Sie Fabrics Patterns, um Codezusammenfassungen automatisch zu generieren:

• Code-Zusammenfassung: Zusammenfassungen von Funktionen, Modulen und Dateien automatisch generieren
• Architekturdokument：Auf Basis des Codes Architekturdokumentation generieren
• API-Dokumentation：API-Dokumentation basierend auf Code-Kommentaren generieren
• Lernnotizen：Lernnotizen und Wissenszusammenfassungen erstellen

Praxisbeispiel

Fall 1: Sich schnell mit einem Monorepo-Projekt vertraut machen

Projektmerkmale

• Monorepo-Struktur mit mehreren Paketen und Diensten
• pnpm workspaces zur Verwaltung von Abhängigkeiten verwenden
• Großer Codeumfang mit komplexen Abhängigkeiten zwischen den Modulen

Schritt 1: Verwende Windsurf, um die Struktur schnell zu verstehen (1 Tag)

• Öffnen Sie Windsurf und laden Sie das gesamte Monorepo
• Verwenden Sie Fast Context, um die Projektstruktur zu analysieren
• Die Abhängigkeiten zwischen Paketen verstehen
• Kernpakete und wichtige Module identifizieren

Schritt 2: Cursor Agent verwenden, um die wichtigsten Module zu erkunden (2 Tage)

• Wähle die Kernpakete aus und nutze Cursor Agent für Code-Q&A
• Die Verantwortlichkeiten und Schnittstellen von Modulen verstehen
• Datenfluss und Aufrufkette verstehen
• Modul-Dokumentation und Architekturdiagramme erstellen

Schritt 3: Eine kleine Funktion entwickeln (3 Tage)

• Wähle eine kleine Funktion zur Entwicklung aus
• Entwicklungsablauf und Codekonventionen verstehen
• Cursor Agent zur Unterstützung der Entwicklung verwenden
• Code einreichen und Code-Review durchführen

Schritt 4: Wissensaufbau (laufend)

• Einen Cursor Skill erstellen, um projektspezifische Entwicklungsmuster zu kapseln
• Projektdokumentation aktualisieren und fehlende Informationen ergänzen
• Lernergebnisse im Team teilen

Fall 2: Schnell mit einem Legacy-System vertraut werden

Projektmerkmale

• Altsysteme, uneinheitliche Codequalität
• Die Dokumentation fehlt oder ist unvollständig
• Der Tech-Stack ist älter und erfordert das Verständnis des historischen Designs

Schritt 1: Verwenden Sie Zread, um das GitHub-Repository zu analysieren (ein halber Tag)

• Zread verwenden, um die Repository-Struktur zu analysieren
• Tech-Stack und Abhängigkeiten verstehen
• Die Commit-Historie ansehen, um die Entwicklung des Projekts zu verstehen
• Wichtige Dateien und Module identifizieren

Schritt 2: NotebookLM verwenden, um die Dokumente zu organisieren (1 Tag)

• Vorhandene Dokumente und README importieren
• NotebookLM verwenden, um wichtige Informationen zu extrahieren
• Projektübersicht und Wissensgraph generieren
• Q&A basierend auf dem Dokumentinhalt

Schritt 3: Verwenden Sie Cursor Agent, um den Code zu verstehen (2–3 Tage)

• Schlüsselmodule auswählen und Cursor Agent für Code-Fragen und -Antworten verwenden
• Geschäftslogik und Implementierungsdetails verstehen
• Codeprobleme und Verbesserungspotenziale erkennen
• Codekommentare und Dokumentation generieren

Schritt 4: Refactoring und Optimierung (fortlaufend)

• Codeprobleme identifizieren und Refactoring-Vorschläge machen
• Cursor Agent zur Unterstützung beim Refactoring verwenden
• Die Dokumentation aktualisieren und den Refactoring-Prozess dokumentieren
• Best-Practice-Dokumentation erstellen

Checkliste der Lernergebnisse

Code-Lesestrategien (Top-down vs. Bottom-up) beherrschen und je nach Situation die passende Strategie wählen

Das Projektverständnis-Framework (Geschäftsverständnis → Architekturverständnis → Codeverständnis) verstehen und neue Projekte systematisch erfassen können.

Beherrschen Sie den Schnellstart-Workflow (Dokumentation lesen → Code erkunden → kleine Funktionen entwickeln → Refactoring-Optimierung)

Mit Windsurf Fast Context große Codebasen schnell verstehen

Cursor Agent für Code-Erkundung und Fragen und Antworten verwenden können

In der Lage sein, GitHub-Repositories mit Zread zu analysieren

Kann NotebookLM und Fabric für die Dokumentenorganisation und Wissensextraktion verwenden

Die Fähigkeit besitzen, Wissen aufzubauen und zu teilen, Skills/Patterns zu erstellen und Dokumentationen zu aktualisieren

Mindestens einen Praxisfall abschließen (Monorepo-Projekt oder Legacy-System)