개발자 문서에는 일반적으로 각 파일에 설명이 포함되어 있습니다. 이 설명은 오래되어 혼란과 잘못된 정보를 초래할 수 있습니다. 이를 방지하려면 약간의 AI 및 GenAIScript를 사용하여 문서에서 오래된 설명 감지를 자동화할 수 있습니다.

마크다운과 서문

많은 문서 시스템은 마크다운 형식을 사용하여 문서를 작성하고 '머리말' 헤더를 사용하여 메타데이터를 저장합니다. 다음은 머리말이 포함된 마크다운 파일의 예입니다:

---
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 파이프라인에 통합하여 탐지 프로세스를 자동화할 수 있습니다.