Entwicklerdokumentation enthält normalerweise eine Beschreibung in jeder Datei. Diese Beschreibungen können veraltet sein, was zu Verwirrung und falschen Informationen führen kann. Um dies zu verhindern, können Sie die Erkennung veralteter Beschreibungen in Ihrer Dokumentation mithilfe von KI und GenAIScript automatisieren.

Markdown und Frontmatter

Viele Dokumentationssysteme verwenden das Markdown-Format zum Schreiben der Dokumentation und einen „Frontmatter“-Header zum Speichern von Metadaten. Hier ist ein Beispiel einer Markdown-Datei mit frontmatter:

---
title: "My Document"
description: "This is a sample document."
---

# My Document

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Ziel ist es, ein Skript zu erstellen, das erkennt, wenn das Beschreibungsfeld im Frontmatter veraltet ist.

Das Drehbuch

GenAIScript soll auf Dateien ausgeführt werden und stellt eine spezielle Variable env.files bereit, die die Liste der zu analysierenden Dateien enthält. Sie können diese Variable verwenden, um die Dateien mithilfe der Def-Funktion in den Kontext einzubinden. Wir begrenzen jede Datei auf 2000 Token, um zu vermeiden, dass der Inhalt bei großen Dateien explodiert.

// Define the file to be analyzed
def("DOCS", env.files, { endsWith: ".md", maxTokens: 2000 })

Der nächste Schritt besteht darin, dem Skript eine Aufgabe zu geben. Überprüfen Sie in diesem Fall, ob das Inhalts- und Beschreibungsfeld im Frontmatter übereinstimmt.

// Analyze the content to detect outdated descriptions
$`Check if the 'description' field in the front matter in DOCS is outdated.`

Schließlich nutzen wir die integrierte Funktion zur Diagnosegenerierung, um für jede veraltete Beschreibung einen Fehler zu erstellen.

// enable diagnostics generation
$`Generate an error for each outdated description.`

Läuft in Visual Studio Code

Sobald Sie dieses Skript in Ihrem Arbeitsbereich speichern, können Sie es über das Kontextmenü für eine Datei oder einen Ordner ausführen
durch Auswahl von GenAIScript ausführen....

Automatisierung

Sie können dieses Tool automatisch in Ihren Dokumentationsdateien ausführen, um veraltete Beschreibungen mithilfe der CLI zu identifizieren.

npx --yes genaiscript run detect-outdated-descriptions **/*.md

Dieses Skript kann in Ihre CI/CD-Pipeline integriert werden, um den Erkennungsprozess zu automatisieren.