GitHub Copilot 사용하여 프로젝트 설명서 생성

6분

프로젝트 설명서에서는 프로젝트의 목적, 목표 및 요구 사항을 설명합니다. 프로젝트 설명서를 만들려면 프로젝트 구조, 해당 구성 요소 및 구성 요소가 서로 상호 작용하는 방식을 이해해야 합니다.

GitHub Copilot 채팅 보기는 전체 프로젝트 구조를 분석하고 프로젝트의 개략적인 개요를 제공할 수 있으므로 프로젝트 설명서를 생성하는 데 이상적인 도구입니다. 채팅 보기를 사용하여 추가 정보 파일, API 참조 및 기타 프로젝트 관련 문서와 같은 특정 유형의 설명서를 생성할 수도 있습니다.

각 채팅 보기 모드(Ask, Agent 또는 Plan)를 사용하여 프로젝트 설명서를 생성할 수 있습니다. 각 모드에는 고유한 강점과 약점이 있습니다. 프로젝트 사양 및 기타 제약 조건은 사용해야 하는 모드에 영향을 줍니다.

중요합니다

에이전트 모드에서 채팅 보기를 사용할 때 입력하는 각 프롬프트는 모델의 배수만큼 곱해진 하나의 프리미엄 요청으로 계산됩니다. GitHub Copilot 작업을 완료하기 위해 몇 가지 후속 작업을 수행할 수 있지만 이러한 후속 작업은 프리미엄 요청 사용량에 포함되지 않습니다. 입력한 프롬프트만 요금이 청구됩니다. 사용되는 총 프리미엄 요청은 입력한 프롬프트 수와 선택한 모델에 따라 달라집니다.

프로젝트 설명서 요구 사항 설정

설명서 유형 및 콘텐츠 요구 사항은 프로젝트, 의도된 소비자 및 조직에서 채택한 표준에 따라 달라집니다.

예를 들어 README.md 다음 섹션을 포함할 수 있습니다.

프로젝트 제목: 프로젝트의 이름입니다.
설명: 프로젝트가 수행하는 작업과 프로젝트의 존재 이유에 대한 간략한 개요입니다.
목차: 선택 사항이지만 더 긴 README에 유용합니다.
설치: 프로젝트를 설치하고 설정하는 방법에 대한 지침입니다.
사용법: 코드 조각 또는 스크린샷을 포함하여 프로젝트를 사용하는 방법의 예입니다.
기능: 주요 기능 또는 기능 목록입니다.
구성: 구성 옵션 또는 환경 변수에 대한 세부 정보입니다.
기여: 프로젝트에 기여하기 위한 지침입니다.
라이선스: 분산 프로젝트에서 사용하는 모든 라이선스입니다.
크레딧 및 승인: 사용된 기여자, 라이브러리 또는 리소스의 인식입니다.
연락처: 유지 관리자 또는 프로젝트 팀에 연락하는 방법
Changelog: 변경 내용 및 업데이트 기록(경우에 따라 별도의 파일에 연결됨).

GitHub Copilot 채팅은 프로젝트 및 관련자의 특정 요구 사항을 충족하는 프로젝트 설명서를 생성하는 데 도움이 될 수 있습니다.

요청 에이전트 모드를 사용하여 프로젝트 설명서 생성

Ask 에이전트 모드를 사용하여 작업 영역을 분석한 다음, 설명서를 생성할 수 있습니다.

다음 프로세스를 사용하여 요청 에이전트 모드를 사용하여 프로젝트 설명서를 생성합니다.

설명서 요구 사항 및 지원 리소스를 식별합니다.
- 프로젝트에 대한 설명서 요구 사항을 식별합니다. 설명서 유형 및 필요한 문서 섹션을 식별합니다.
- 설명서를 생성하는 데 필요한 리소스를 식별합니다. 코드 작업 영역이 유일한 필수 리소스일 수 있습니다. 그러나 "기여", "크레딧" 및 "연락처"와 같은 섹션의 채팅에 컨텍스트를 추가해야 할 수 있습니다.
채팅 보기를 열고 에이전트 요청 모드를 사용하여 새 채팅 세션을 시작합니다.
채팅 세션에 컨텍스트를 추가합니다.
- Visual Studio Code 탐색기 보기에서 채팅 보기로 파일을 끌어서 놓아 채팅 세션에 컨텍스트를 추가할 수 있습니다. 컨텍스트 연결 단추(클립 아이콘)를 사용할 수도 있습니다.
- 코드 편집기에서 외부 파일을 열어 작업 영역에 속하지 않은 리소스를 포함하고 이를 사용하여 더 많은 컨텍스트를 제공할 수 있습니다. 예를 들어 기여자 지침 또는 연락처 정보가 포함된 markdown 파일을 연 다음 컨텍스트 연결 단추를 사용하여 채팅 보기 컨텍스트에 추가할 수 있습니다.
설명서 요구 사항을 조사하는 일련의 프롬프트를 입력합니다.

Ask 에이전트 모드를 사용하여 작업 영역을 분석하고 설명서 요구 사항을 지원하는 채팅 세션 기록을 작성할 수 있습니다. 목표를 설명하면 채팅 세션의 컨텍스트를 설정하는 데 도움이 될 수 있습니다. 요구 사항을 해결하는 질문을 하면 GitHub Copilot 설명서를 생성하는 데 필요한 정보를 식별하는 데 도움이 됩니다.

필요에 따라 추가된 컨텍스트를 새로 고칩니다.
첫 번째 단계에서 식별한 필수 섹션을 나열하여 제안된 프로젝트 설명서를 요청하는 프롬프트를 입력합니다.

예: "@workspace /explain I need help creating a README file that can be used in the GitHub repository for this workspace. The file should be formatted as markdown. The README file needs to include the following sections: Project Title, Description, Table of Contents, Installation, Usage, Features, Configuration, and License."
제안된 프로젝트 설명서를 검토하고 필요한 경우 새 프롬프트를 사용하여 결과를 구체화합니다.
제안된 프로젝트 설명서를 프로젝트 설명서 파일로 이동합니다.

예를 들어 작업 영역의 루트에 README.md 파일을 만들고 제안된 콘텐츠를 파일에 삽입합니다.

에이전트 요청 모드를 사용하여 문서를 만든 후 프로젝트의 특정 섹션에 대한 업데이트를 제안하거나 다른 GitHub Copilot 도구를 사용하여 업데이트를 도울 수 있습니다.

계획 모드를 사용하여 프로젝트 설명서 생성

계획 모드는 프로젝트 설명서를 생성하기 전에 자세한 구현 계획을 만드는 데 가장 적합합니다. 계획 모드는 코드베이스를 분석하고, 설명서 요구 사항을 식별하며, 단계별 계획을 생성합니다. 계획이 승인되면 실행을 위해 에이전트 모드로 넘겨줄 수 있습니다.

다음 프로세스를 사용하여 계획 모드를 사용하여 README.md 파일과 같은 프로젝트 설명서를 생성합니다.

설명서 요구 사항 및 지원 리소스를 식별합니다.
채팅 보기를 열고 계획 모드를 사용하여 새 채팅 세션을 시작합니다.
설명서 작업을 설명하는 프롬프트를 입력합니다.

예: "이 프로젝트에 대한 추가 정보 파일 및 지원 설명서를 만들어야 합니다. 추가 정보에는 프로젝트 제목, 설명, 목차, 설치, 사용, 기능, 구성 및 라이선스가 포함되어야 합니다."
구현 계획을 검토합니다.

잠시 후 계획 에이전트는 채팅 보기에서 계획을 출력합니다. 이 계획은 설명에 대한 열린 질문을 포함하여 개략적인 요약 및 단계 분석을 제공합니다. 요구 사항을 명확히 하거나 범위를 조정하거나 질문에 대답하기 위해 여러 번 반복할 수 있습니다.
계획이 완료되면 시작 구현 을 선택하여 계획을 에이전트 모드로 전달하거나 편집기에서 열기 를 선택하여 나중에 사용할 수 있도록 계획을 Markdown 파일로 저장합니다.

구현 시작 선택하면 GitHub Copilot 에이전트 모드로 전환되고 승인된 계획에 따라 설명서 구현을 시작합니다. 생성된 설명서 파일을 검토하고 변경 내용을 적용하거나 취소합니다.

에이전트 모드를 사용하여 프로젝트 설명서 생성

에이전트 모드는 프로젝트에 대한 심층적인 이해가 필요한 프로젝트 설명서를 생성하는 데 가장 적합합니다. 에이전트 모드는 프로젝트 설명서를 생성하기 전에 전체 프로젝트 구조를 분석합니다. 에이전트 모드는 여러 파일 및 폴더에서 정보를 수집하여 복잡한 관계를 설명하고 문서 간 링크를 포함할 수 있습니다.

다음 프로세스를 사용하여 에이전트 모드를 사용하여 README.md 파일과 같은 프로젝트 설명서를 생성합니다.

설명서 요구 사항 및 지원 리소스를 식별합니다.
채팅 보기를 열고 에이전트 모드를 사용하여 새 채팅 세션을 시작합니다.
채팅 세션에 컨텍스트를 추가합니다.

채팅 참가자는 에이전트 모드에서 사용할 수 없으므로 프롬프트의 일부로 지정할 @workspace 수 없습니다. 그러나 #codebase를 사용하여 채팅 세션에 컨텍스트를 추가하고, 작업 영역 파일 및 폴더를 채팅 컨텍스트에 추가할 수 있습니다. 외부 파일을 Visual Studio Code 연 다음 컨텍스트 연결 단추를 사용하여 채팅 컨텍스트에 추가할 수 있습니다.
원하는 프로젝트 설명서를 만들라는 프롬프트를 입력합니다.

예: "프로젝트 설명서 파일의 컬렉션을 생성합니다. 이 리포지토리에 대한 작업 영역 README.md 파일을 만들거나 업데이트합니다. UsageExamples.md 파일을 만들거나 업데이트합니다. ChangeLog.md 파일을 만들거나 업데이트합니다. 문서 파일, 상호 참조 클래스 및 메서드 간의 링크를 포함하고 문서 전체에서 일관성을 보장합니다."
문서 파일을 검토한 다음, 업데이트를 저장하거나 삭제합니다.

필요한 경우 프롬프트를 사용하여 파일을 업데이트하여 특정 섹션을 수정하거나 향상시킵니다.

에이전트 모드 기능

에이전트 모드가 가장 적합한 몇 가지 설명서 작업이 있습니다.

다중 파일 및 파일 간 설명서 생성
- 에이전트 모드는 전체 프로젝트 구조를 분석하고, 여러 파일 및 폴더에서 정보를 수집하고, 코드베이스에서 콘텐츠를 연결하고 요약하는 설명서를 생성할 수 있습니다. 예를 들어 모든 주요 구성 요소를 설명하는 전체 API 참조 또는 README를 생성하는 것
자동화된 프로젝트 분석 및 요약.
- 에이전트 모드는 아키텍처 요약, 기본 클래스/서비스 식별, 파일과 구성 요소 간의 관계를 이해해야 하는 다이어그램 또는 테이블 생성과 같은 작업을 수행할 수 있습니다.
동적 콘텐츠 생성(예: 사용 예제, 클래스 테이블)
- 에이전트 모드는 프로젝트를 검색하여 사용 예제, 클래스 책임 테이블 또는 공용 API 목록을 생성할 수 있습니다.
문서 작업을 일괄로 처리합니다.
- 에이전트 모드는 한 워크플로에서 일련의 설명서 작업(예: 추가 정보 업데이트, CONTRIBUTING.md 만들기, API 문서 생성, 변경 로그 업데이트)을 실행할 수 있습니다.
지능형 연결 및 탐색.
- 에이전트 모드는 설명서 파일, 상호 참조 클래스 및 메서드 간에 링크를 만들고 문서 간에 일관성을 유지할 수 있습니다.

에이전트 모드는 분석, 합성 및 조정이 필요한 프로젝트 차원의 다중 파일 및 컨텍스트 인식 설명서 작업에 적합합니다.

요약

GitHub Copilot 프로젝트 및 관련자의 특정 요구 사항을 충족하는 프로젝트 설명서를 생성하는 데 도움이 될 수 있습니다. 채팅 보기를 사용하여 요청, 에이전트 및 플랜의 세 가지 모드로 프로젝트 설명서를 생성할 수 있습니다. 각 모드에는 고유한 강점과 약점이 있으며 가장 적합한 모드는 현재 진행 중인 특정 작업에 따라 달라집니다. 에이전트 요청 모드는 코드베이스 또는 기술 개념에 대한 질문을 하는 데 가장 적합합니다. 에이전트 모드는 프로젝트에 대한 심층적인 이해가 필요한 프로젝트 설명서를 생성하는 데 가장 적합합니다. 계획 모드는 설명서를 생성하기 전에 자세한 구현 계획을 만드는 데 가장 적합합니다. 그러면 실행을 위해 에이전트 모드로 전달될 수 있습니다.

피드백

이 페이지가 도움이 되었나요?