Was macht write-tech-spec?
Erstelle eine TECH.md-Spezifikation für eine bedeutende Warp-Funktion, nachdem du den aktuellen Codebestand und die Implementierungsbeschränkungen recherchiert hast. Verwende es, wenn der Benutzer nach einem technischen Lastenheft, Implementierungsplan oder Architekturdokument fragt, das mit einem Produktlastenheft verbunden ist.
Funktionsweise
- Recherche des Codebestands: Die Fähigkeit durchsucht den vorhandenen Quellcode von Warp, um relevante Module, APIs und Datenstrukturen zu identifizieren.
- Identifikation von Beschränkungen: Sie analysiert bestehende Abhängigkeiten, Leistungsanforderungen und Sicherheitsrichtlinien, die die Implementierung beeinflussen.
- Erstellung der Spezifikation: Auf Basis der Recherche wird eine detaillierte
TECH.mderstellt, die folgende Abschnitte enthält:- Überblick: Kurze Beschreibung der Funktion und ihrer Ziele.
- Architektur: Diagramme und Beschreibungen der beteiligten Komponenten.
- Schnittstellen: Definition von APIs, Events und Datenflüssen.
- Implementierungsschritte: Schritt-für-Schritt-Plan für die Entwicklung.
- Tests: Strategien für Unit-, Integrations- und End-to-End-Tests.
- Risiken und Abhängigkeiten: Bekannte Herausforderungen und externe Abhängigkeiten.
Verwendung
Rufe diese Fähigkeit auf, wenn ein Benutzer eine Anfrage wie folgt stellt:
- „Erstelle eine technische Spezifikation für Funktion X.“
- „Schreibe einen Implementierungsplan für die Integration von Y.“
- „Dokumentiere die Architektur für das neue Feature Z.“
Plattformen
- Warp: Die Fähigkeit ist für die Warp-Plattform optimiert und nutzt deren Codebasis und Konventionen.
Beispielausgabe
Die generierte TECH.md folgt einem standardisierten Format, das an die spezifischen Anforderungen des Projekts angepasst werden kann.