通常、開発者向けドキュメントには各ファイルに説明が含まれています。この説明は古くなり、混乱や不正確な情報につながる可能性があります。これを防ぐには、AI と GenAIScript を少し使用して、ドキュメント内の古い説明の検出を自動化できます。

マークダウンとフロントマター

多くのドキュメント システムでは、マークダウン形式を使用してドキュメントを記述し、「frontmatter」ヘッダーを使用してメタデータを保存します。以下は、frontmatter を含むマークダウン ファイルの例です:

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

# My Document

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

目標は、フロントマターの説明フィールドが古くなったときを検出するスクリプトを作成することです。

スクリプト

GenAIScript はファイル上で実行することを目的としており、分析対象のファイルのリストを含む特別な変数 env.files を提供します。この変数を使用すると、def 関数を使用してファイルをコンテキストに含めることができます。大きなファイルのコンテンツの爆発を避けるために、各ファイルは 2000 トークンに制限されています。

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

次のステップは、スクリプトにタスクを与えることです。この場合、フロントマターのコンテンツと説明フィールドが一致していることを確認します。

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

最後に、組み込みの診断生成機能を利用して、古い説明ごとにエラーを作成します。

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

Visual Studio Codeで実行する

このスクリプトをワークスペースに保存すると、コンテキスト メニューからファイルまたはフォルダーで実行できるようになります
GenAIScript を実行....

オートメーション

cli を使用して、ドキュメント ファイルに対してこのツールを自動的に実行し、古い説明を特定できます。

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

このスクリプトを CI/CD パイプラインに統合して、検出プロセスを自動化できます。