기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
시작하기 전에 설명서 생성을 지원하는 IDE에 Amazon Q를 설치했는지 확인합니다. 자세한 내용은 에 Amazon Q Developer 확장 프로그램 또는 플러그인 설치 IDE 단원을 참조하십시오.
IDE에서 Amazon Q를 사용하여 READMEs를 생성하거나 업데이트하려면 다음 절차를 완료하세요.
-
Amazon Q 확장이 설치된 IDE를 엽니다.
-
Amazon Q 아이콘을 선택하여 채팅 패널을 엽니다.
/doc을 입력합니다. -
새 채팅 탭이 열립니다. Amazon Q는 코드에 대한 새 README를 생성하거나 기존 README를 업데이트하라는 메시지를 표시합니다.
-
작업할 설명서 작업 유형을 선택합니다.
기존 README를 업데이트하는 경우 Amazon Q가 최근 코드 변경 사항으로 README를 업데이트할지 또는 Amazon Q가 README에 적용해야 하는 특정 변경 사항을 제공할지 선택합니다.
-
Amazon Q는 IDE에서 현재 열려 있는 폴더에 대한 설명서를 생성하거나 새 폴더를 선택할 것인지 확인하라는 메시지를 표시합니다.
README를 구체적으로 변경하기로 선택한 경우 Amazon Q에서 수행할 업데이트를 자세히 설명합니다. 설명에 포함할 항목에 대한 아이디어는 섹션을 참조하세요모범 사례.
Amazon Q가 설명서 생성을 시작합니다.
-
Amazon Q가 문서를 생성한 후 변경 사항을 구분합니다. 차이점을 검토한 다음 채팅에서 수락을 선택하여 README를 업데이트할 수 있습니다.
생성된 설명서를 변경하려면 변경하기를 선택합니다. 그런 다음 Amazon Q에서 변경하려는 내용을 설명하면 업데이트된 README가 생성됩니다.
