Code Assistant

Der Code Assistant ist Teil der FirstSpirit AI Assistant Suite. Dieser KI-basierte Assistent analysiert Ihren HTML-Code und zeigt Verbesserungsmöglichkeiten auf. Sie können dafür den voll funktionsfähigen Prompt von Crownpeak verwenden oder diesen abändern, um die bei der Analyse in Betracht gezogenen Themenbereiche projektspezifisch zu definieren.

Zusätzlich zum Code Assistant umfasst die AI Assistant Suite folgende Tools:

• Content Assistant
• Analyze Assistant
• Image Assistant

Um den Code Assistant im Template Development für ContentCreator verwenden zu können, müssen Sie die FirstSpirit AI konfigurieren.

Wie auch die anderen Assistenten der FirstSpirit AI Assistant Suite, können Sie die Prompts des Code Assistants im ServerManager konfigurieren. Außerdem können Sie mit den entsprechenden Rechten Prompts auch direkt im ContentCreator bearbeiten.

FirstSpirit bietet einen voreingestellten funktionalen Prompt für den Code Assistant. Dieser Prompt analysiert Ihren Code und bietet Verbesserungsvorschläge zu den folgenden Aspekten:

• Accessibility
• Search Engine Optimization
• Web Development Best Practices

Sollten Sie einen benutzerdefinierten Prompt benötigen, empfehlen wir, den voreingestellten Prompt zu duplizieren und diesen entsprechend Ihren Bedürfnissen anzupassen, z.B. um die Kategorien zu ändern.

Sie können sowohl in der Vollbildansicht als auch im Dialogfenster die Vorlagen eines Projekts mit dem Code Assistant analysieren. Problemstellen in Vorlagen sind somit im "Code Assistant"-Report leicht ersichtlich und Sie können diese per Mausklick erreichen.

Sie können den Code Assistant in folgenden Bereichen nutzen:

• in der Vollbild-Ansicht über das "Code Assistant"-Symbol
  
• im Dialogfenster über das "Code Assistant"-Symbol
  

Um eine Vorlage mit dem Code Assistant in der Vollbildansicht oder im Dialogfenster zu analysieren:

• Öffnen Sie eine Vorlage in der Vorlagenentwicklung für den ContentCreator in der Vollbild-Ansicht.
  Alternativ: Öffnen Sie eine Vorlage im Dialogfenster.
• Klicken Sie auf das "Code Assistant"-Symbol.
  → Der Code Assistant-Report öffnet sich und die Analyse der Seite startet automatisch.
  
  → Einträge, die mit gekennzeichnet sind, markieren Probleme in Vorlagen. Jeder Eintrag beschreibt eine Verbesserungsmöglichkeit sowie die Kategorie, die der Verbesserungsmöglichkeit zugeschrieben wird.

• Optional: Konfigurieren Sie den Code Assistant-Prompt.
• Gibt es für einen Eintrag konkrete Problemstellen, können Sie den Eintrag mit ausklappen.
  → Es wird der Referenzname und die Zeilennummer der betroffenen Vorlage angezeigt.
  
• Klicken Sie auf den Referenznamen, um direkt zur betroffenen Vorlage und Zeile zu gelangen.
  → Befinden Sie sich in der Vollbildansicht und die betroffene Vorlage ist nicht die aktuell geöffnete, wird ein neuer Tab mit der betroffenen Vorlage geöffnet. Befinden Sie sich im Dialogfenster, wird ein neues Dialogfenster geöffnet.
• Bewegen Sie den Mauszeiger über das Symbol neben der betroffenen Zeile.
  → Es wird eine Erläuterung der Problemstellung betreffend der aktuellen Zeile angezeigt.

Mit den entsprechenden Rechten können Sie den "Code Assistant"-Prompt direkt im ContentCreator konfigurieren und so Ihren individuellen Bedürfnissen anpassen:

• Im "Code Assistant"-Report klicken Sie auf das Edit Prompt-Symbol .
  → Das Fenster Operation bearbeiten öffnet sich. Hier können Sie den Prompt bearbeiten, Optionen zuweisen, neue Optionen hinzufügen und den Prompt testen.
  

Prompt bearbeiten

Um einen Prompt direkt im ContentCreater zu bearbeiten:

• Im Fenster Operation bearbeiten, klicken Sie in das Textfeld Prompt, um diesen zu bearbeiten.
• Optional: Ändern Sie den Namen der Operation im Textfeld Name.
• Speichern Sie Ihre Änderungen.

Optionen verwalten

Um eine bereits existierende Option der Operation zuzuweisen:

• Im Fenster Operation bearbeiten weisen Sie der Operation eine existierende Option hinzu, indem Sie einen Haken in der Checkbox in der Spalte Verwenden setzen.
• Speichern Sie Ihre Änderungen.

Um eine neue Option hinzuzufügen:

• Im Fenster Operation bearbeiten klicken Sie auf Neue Option anlegen.
  → Das Fenster Option bearbeiten öffnet sich.
  
• Im Feld Name, geben Sie den Anzeigenamen der Option an.
• Klicken Sie auf Neuen Eintrag anlegen um einen neuen Optionswert hinzuzufügen.
  → Das Fenster Eintrag bearbeiten öffnet sich.
  
• Im Feld Name geben Sie den Anzeigenamen des Optionswertes an.
• Im Feld Prompt geben Sie den Prompt des Optionswertes an.
• Klicken Sie auf Übernehmen um die Änderungen zu speichern.
• Optional: Fügen Sie weitere Einträge hinzu.
• Klicken Sie auf Speichern um Ihre neu hinzugefügte Option zu speichern.
• Weisen Sie Ihre neu hinzugefügte Option der aktuellen Operation zu.

Um eine existierende Option zu bearbeiten:

• Im Fenster Operation bearbeiten klicken Sie auf das Symbol Option bearbeiten .
  → Das Fenster Option bearbeiten öffnet sich.
• Ändern Sie den Anzeigenamen der Option sowie den Anzeigenamen und Prompt der Optionswerte oder fügen Sie einen neuen Optionswert hinzu.
• Speichern Sie Ihre Änderungen.

Prompt testen

Um Ihren Prompt direkt im ContentCreator zu testen:

• Im Fenster Operation bearbeiten klicken Sie auf Prompt testen.
  → Die Sprechblase Prompt testen öffnet sich.
• Klappen Sie die Test-Einstellungen auf.
• Wählen Sie ein Test-Plugin, um Ihren Prompt in einer spezifischen Umgebung zu testen, z.B. ContentAssistantPromptConfigurationTestPlugin um Ihre Eingabeaufforderung für die Verwendung im Content Assistant zu testen.
  → Der Text im Feld Text Eingabe ändert sich je nach dem gewählten Test-Plugin.
• Optional: Bearbeiten Sie den Text im Feld Text Eingabe.
• Optional: Bearbeiten Sie Ihren Prompt im Feld Prompt, wenn die API-Antwort unzufriedenstellend war, und testen Sie ihn erneut.