Dokumentation: Guide-Modus

Als Markdown anzeigen

Guide-Modus

Verfügbar ab 0.2.4

Lassen Sie einen Agenten einen Ablauf in einer beliebigen Web-App durchgehen, und Astral schreibt die Benutzeranleitung für Sie.

Was Sie erhalten

Eine Anleitung, geschrieben aus einem aufgezeichneten Lauf, im Ordner des Laufs neben report.html:

  • guide.md und guide.html (eine in sich geschlossene Seite): ein Titel, eine Einleitung, ein nummerierter Abschnitt pro Schritt und eine nummerierte Anweisung für jede Aktion.
  • Ein Screenshot pro Aktion, vor einem Klick aufgenommen, mit markiertem Ziel.
  • Ein abschließender Abschnitt Ergebnis mit einem Abschluss-Screenshot.
  • Ein Link zur Aufzeichnung: ein MP4 unter macOS, anderswo ein animiertes PNG.
  • Nur relative Dateinamen, sodass sich der Ordner unverändert verschieben oder zippen lässt.

Bitten Sie Ihren Agenten

Jeder mit Astral verbundene MCP-Agent kann das. Bitten Sie ihn zum Beispiel: „Schreibe eine Benutzeranleitung zum Anlegen eines Kunden auf Spanisch“. Dahinter steht der MCP-Prompt write-guide, den Ihr Agent zusammen mit den anderen auflistet (siehe die Tool-Referenz). Seine Argumente:

  • task (erforderlich): was die Anleitung vermittelt, etwa „wie man ein Konto anlegt“.
  • lang: die Sprache der Anleitung als Code, es oder en (Standard en).
  • url: wo der Durchlauf beginnt (optional: sonst der aktuelle Tab).

Der Agent erkundet den Ablauf, führt ihn einmal als Testlauf mit der Option guide aus, prüft das Ergebnis und meldet die Dateien.

Die Option guide

Der Prompt verwendet eine Option von astral.test, die Sie auch selbst in einem Skript setzen können:

await astral.test('Create a customer', async () => {
  await astral.step('Open the customers page', () =>
    astral.navigate({url: 'http://127.0.0.1:4555/'}));
  // ...the rest of the flow
}, {
  record: 'video',
  guide: {lang: 'es', title: 'Crear un cliente', intro: 'Cómo dar de alta un cliente nuevo.'}
});

guide nimmt lang, title und intro entgegen. Es schaltet die Screenshots pro Aktion von selbst ein; fügen Sie record: 'video' hinzu, um auch eine Aufzeichnung zu erhalten. Das Ergebnis des Laufs enthält guide: {md, html, lang}.

Sprachen

Die auf der Seite eingezeichneten Beschriftungen und die Bezeichnungen der Anleitung (Ergebnis, Aufzeichnung ansehen, Screenshot) sind für Englisch und Spanisch übersetzt. Jeder andere Sprachcode fällt auf englische Beschriftungen zurück, während Schrittnamen, Titel und Einleitung in der Sprache bleiben, in der der Agent sie geschrieben hat. Benennen Sie jeden Schritt so, wie es der Benutzer tun würde, etwa „Konto erstellen“, nicht so, wie es ein Test täte.

Passwörter

Ein getipptes Passwort gelangt nie in die Anleitung. Die Anweisung lautet „Type your password in «Password»“ (oder „Escribe tu contraseña en «Password»“ auf Spanisch), und der Wert wird in keine Datei geschrieben.

Fehlgeschlagene Durchläufe

Schlägt ein Schritt fehl, wird die Anleitung trotzdem geschrieben, beginnt aber mit einer Warnung, „This walkthrough did not complete: step N failed. Do not publish this guide as it is.“ (in der Sprache der Anleitung), und der fehlgeschlagene Schritt wird markiert. Beheben Sie den Ablauf und führen Sie ihn erneut aus.

Wie es aussieht

Die guide.md eines echten Laufs gegen die Demo-App DevLab (nur die Adresse ist ersetzt):

# Cómo crear una cuenta

Esta guía te lleva por el registro paso a paso.

## 1. Abre la página de registro

1. Ve a https://your-app.example/register

   ![Captura de pantalla](01-step1-navigate.png)

## 2. Rellena tus datos

1. Escribe «Ana Guía» en «Name»

   ![Captura de pantalla](03-step2-type.png)

2. Escribe «[email protected]» en «Email»

   ![Captura de pantalla](04-step2-type.png)

3. Escribe tu contraseña en «Password»

   ![Captura de pantalla](05-step2-type.png)

4. Escribe tu contraseña en «Confirm password»

   ![Captura de pantalla](06-step2-type.png)

## 3. Crea la cuenta

1. Haz clic en «Create account»

   ![Captura de pantalla](08-step3-click-before.png)

## Resultado

![Resultado final](10-step3-final.png)

[Ver la grabación](recording.mp4)

Die Feldnamen stammen aus den eigenen Beschriftungen der App, sodass eine englische App „Email“ in spanischen Sätzen ergibt.

Plattformen

Nur auf macOS verifiziert. Die MP4-Aufzeichnung wird unter macOS kodiert; auf anderen Systemen ist die Aufzeichnung ein animiertes PNG. Windows und Linux sind für den Guide-Modus nicht verifiziert.