Best Practices für Workflows

Das Erstellen guter Workflows erfordert das richtige Gleichgewicht zwischen klaren Anweisungen, Modularität und dem Einsatz von Tools. Nutzen Sie die folgenden Tipps als Leitfaden.

Workflows mit Careti erstellen

Careti versteht Ihren Projektkontext und ist damit ein hervorragender Partner für das Workflow-Design.

Ein Workflow zum Erstellen von Workflows

Das Erstellen von Workflows ist einfacher als es aussieht – und Sie können sogar einen Workflow verwenden, um einen neuen zu erstellen.

Speichern Sie zunächst die Datei create-new-workflow.md in Ihrem Workspace (zum Beispiel unter .agents/context/workflows/).

Führen Sie dann /create-new-workflow.md aus, und Careti wird Sie durch folgende Schritte führen:

1. Abfrage des Zwecks und eines Kurznamens
2. Beschreibung von Zielen und erwarteten Ergebnissen
3. Organisation der wichtigsten Schritte
4. Generierung einer strukturierten Workflow-Datei

💡Tip

Automatisieren Sie Ihre Arbeitsprotokolle: Abgeschlossene Aufgaben sind hervorragende Kandidaten für Workflows. Fragen Sie nach Abschluss einer Aufgabe: „Mache aus dem, was ich gerade getan habe, einen Workflow“, und Careti wird die Konversation analysieren und eine Workflow-Datei generieren.

Speichern Sie projektspezifische Workflows in .agents/context/workflows/ und globale Workflows in ~/Documents/Careti/Workflows/. Bei Namenskonflikten haben Projekt-Workflows Vorrang.

Workflow-Design

💡Tip

Klein anfangen: Beginnen Sie mit einem Workflow für eine einzelne Aufgabe und erweitern Sie diesen, sobald Sie sich sicher fühlen.

Modularität

Kleinere, wiederverwendbare Workflows sind einfacher zu warten und zu debuggen als ein einzelner großer Workflow.

Klare Kommentare

Wie beim Code kommt es darauf an, das Warum zu erklären. Gute Kommentare helfen sowohl Careti als auch Ihrem Team, die Absicht zu verstehen.

Versionskontrolle

Bewahren Sie Workflows in .agents/context/workflows/ auf und committen Sie diese in Git. Dies erleichtert die Versionierung und das Teilen im Team.

Prompt-Design für Careti

Präzision beim Tool-Einsatz

Statt „finde die Datei“ zu sagen, spezifizieren Sie das Tool und den Ort.

• Schlecht: „Finde den User Controller“
• Gut: „Nutze search_files, um UserController unter src/controllers zu finden“

Fortgeschrittene Techniken

Häufig genutzte Tools

Hier sind einige der Tools, die häufig in Workflows verwendet werden:

execute_command

Ausführen von Terminal-Befehlen (Tests, Builds, Git, etc.)

<execute_command>
  <command>npm run test</command>
  <requires_approval>false</requires_approval>
</execute_command>

read_file

Dateien lesen (Code-/Konfigurationsanalyse)

<read_file>
  <path>src/config.json</path>
</read_file>

search_files

Durchsuchen der Codebase

<search_files>
  <path>src/</path>
  <query>UserController</query>
</search_files>

Die Wahl des richtigen Tools ist entscheidend

Verschiedene Tools liefern unterschiedliche Detailgrade. Wählen Sie das effizienteste Tool für die jeweilige Aufgabe.

• Für das Lesen ganzer Dateien: nutzen Sie read_file
• Um schnell Keywords zu finden: nutzen Sie search_files
• Für vollständige Verzeichnisauflistungen: nutzen Sie list_files

Struktur verwenden

Strukturierte Workflows sind für Careti einfacher zu befolgen. Verwenden Sie Abschnitte wie:

• Purpose
• Inputs
• Steps
• Constraints
• Output format

Beispiel für ein Workflow-Format

# Workflow Name

## Purpose
Describe what the workflow does.

## Inputs
- What information or variables are needed?

## Steps
1. Step-by-step instructions
2. Keep steps small and actionable

## Constraints
- Rules, limits, or safety checks

## Output format
- What the assistant should return

Das Befolgen dieser Best Practices hilft Ihnen dabei, Workflows zu erstellen, die zuverlässig, wiederverwendbar und leicht zu warten sind.