agentic-jsdoc은(는) 무엇을 하나요?
LLM 파싱에 최적화된 JSDoc을 작성하고 검토하여 에이전틱 RAG 검색 및 아키텍처 이해를 극대화합니다.
개요
이 스킬은 JSDoc 주석을 AI 에이전트가 코드를 더 잘 이해하고 검색할 수 있도록 특별히 설계된 방식으로 작성합니다. 인간 개발자가 읽기 쉬운 기존 JSDoc과 달리, 이 스킬의 출력은 LLM(대규모 언어 모델)에 의해 구문 분석되고 처리되는 데 최적화되어 있어, 에이전틱 RAG(검색 증강 생성) 파이프라인에서의 코드 검색 정확도와 아키텍처 이해를 크게 향상시킵니다.
주요 기능
- LLM 친화적 JSDoc 생성: 함수 시그니처, 매개변수, 반환 타입, 예외를 명확히 정의하는 구조화된 JSDoc을 생성합니다.
- 에이전틱 RAG 최적화: 검색 가능성과 맥락 이해를 극대화하는 형식과 용어를 사용하여 AI 에이전트가 관련 코드를 더 쉽게 검색할 수 있도록 합니다.
- 기존 JSDoc 검토 및 수정: 기존 JSDoc을 분석하여 LLM 파싱에 비효율적인 패턴(예: 모호한 설명, 불완전한 타입 명시, 누락된 부수 효과)을 식별하고 수정합니다.
- 아키텍처 이해 증진: 함수 간의 의존성, 데이터 흐름, 제어 흐름을 명확히 문서화하여 AI 에이전트가 전체 코드베이스 아키텍처를 이해하는 데 도움을 줍니다.
지원 플랫폼
- Claude Code
- Cursor
- Codex
- 기타 JSDoc을 지원하는 AI 코딩 에이전트
사용 방법
- JSDoc 작성: 함수나 모듈 위에 주석을 추가할 때 이 스킬을 호출하면 LLM 최적화 JSDoc이 생성됩니다.
- JSDoc 검토: 기존 JSDoc을 선택하고 이 스킬을 호출하여 개선이 필요한 부분을 분석하고 수정 제안을 받습니다.
예시
/**
* 사용자 목록을 가져옵니다.
* @param {number} page - 페이지 번호
* @param {number} limit - 페이지당 항목 수
* @returns {Promise<Array<User>>} 사용자 객체 배열
* @throws {ApiError} API 요청 실패 시
* @sideEffect 네트워크 요청을 수행합니다.
*/
이 스킬을 사용한 후:
/**
* 지정된 페이지와 한도에 따라 사용자 목록을 가져옵니다.
* @async
* @function fetchUsers
* @param {number} page - 1부터 시작하는 페이지 번호
* @param {number} limit - 반환할 최대 사용자 수 (1-100)
* @returns {Promise<Array<User>>} 사용자 객체 배열을 해결하는 프로미스
* @throws {ApiError} 네트워크 오류 또는 잘못된 매개변수로 인해 API 요청이 실패한 경우
* @sideEffect GET 요청을 '/users' 엔드포인트로 보냅니다.
* @example
* const users = await fetchUsers(1, 10);
*/
스킬 구성
이 스킬은 다음 구성 요소로 이루어져 있습니다:
SKILL.md: 이 문서 – 스킬 목적과 사용법 설명agentic-jsdoc.js: LLM 최적화 JSDoc을 생성하는 핵심 로직reviewer.js: 기존 JSDoc을 분석하고 개선 제안을 제공하는 검토 모듈
라이선스
MIT
---
**참고**: 이 스킬은 AI 에이전트 성능을 향상시키는 데 중점을 두고 있으며, 때로는 기존 인간 중심 코딩 표준과 다를 수 있습니다. 최상의 결과를 위해 이 가이드라인을 따르는 것이 좋습니다.