프로젝트 문서 생성 (gen-docs)란 무엇인가요?

이 스킬은 사용자가 Go 프로젝트를 스캔하고 문서를 업데이트하도록 요청할 때 사용됩니다. 프로젝트 루트를 나열하여 패키지, 바이너리, 에셋, 설정 파일을 식별하고, `go.mod` 파일을 읽어 모듈 이름, Go 버전, 종속성을 파악합니다. 그 후 각 패키지의 핵심 소스 파일을 읽어 API와 동작을 요약한 후, 프로젝트 제목, 한 줄 개요, 디렉토리 구조, 패키지 설명(주요 함수/타입 포함), 바이너리/CLI 설명, 종속성 및 요구 사항을 포함한 README.md를 생성하거나 업데이트합니다. 마지막으로 파일 경로를 확인하고 사용자에게 예제나 추가 설명이 필요한지 묻습니다. 이 스킬은 주로 '프로젝트 개요 업데이트', '프로젝트 스캔 후 문서 업데이트', '소스에서 프로젝트 수준 문서 생성'과 같은 요청에 대응합니다.

지원 대상~Claude Code~Codex CLI~Cursor

npx skills add https://github.com/karrot0195/agent-skills-/tree/HEAD/.agents/skills/gen-docs

문서

gen-docs

사용자가 프로젝트를 스캔하고 문서(예: README.md)를 업데이트하도록 요청할 때 이 스킬을 사용합니다.

단계

프로젝트 루트를 나열하고 패키지, 바이너리, 에셋, 설정 파일을 식별합니다.
go.mod 파일을 읽어 모듈 이름, Go 버전 및 종속성을 확인합니다.
각 패키지의 핵심 소스 파일을 읽어 API와 동작을 요약합니다.
다음과 같은 내용으로 README.md를 업데이트하거나 생성합니다.
- 프로젝트 제목 및 한 줄 개요
- 디렉토리 구조 (트리 또는 목록)
- 주요 함수/타입을 포함한 패키지 설명
- 바이너리/CLI 설명
- 종속성 및 요구 사항
파일 경로를 확인하고 예제나 사용법과 같은 추가 세부 정보가 필요한지 묻습니다.

사용 시기

사용자가 "프로젝트 개요 업데이트"라고 말할 때
사용자가 "프로젝트 스캔 후 문서 업데이트"를 요청할 때
사용자가 소스에서 프로젝트 수준 문서 생성을 원할 때

프로젝트 문서 생성 (gen-docs)