Amazon Q Developer를 사용한 설명서 생성 모범 사례 - Amazon Q Developer

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

Amazon Q Developer를 사용한 설명서 생성 모범 사례

Amazon Q를 사용한 설명서 생성의 결과를 개선하려면 다음 모범 사례를 따르세요.

  • Amazon Q는 코드 프로젝트 크기 할당량 내에서 모든 양의 코드에 대한 설명서를 생성할 수 있지만, 매우 큰 리포지토리는에 대한 설명서를 생성하는 데 시간이 더 오래 걸리고 덜 구체적일 수 있습니다. 대규모 리포지토리가 있는 경우 코드의 하위 집합 또는 단일 파일에 대한 설명서를 요청하여 보다 구체적인 결과를 얻는 것이 좋습니다.

  • 코드가 잘 주석 처리되고 구성되고, 프로그래밍 엔터티에 대한 명명 규칙이 양호하며, 다른 표준 코딩 규칙을 따르는 경우 Amazon Q가 생성하는 설명서의 품질을 개선할 수 있습니다.

  • Amazon Q는 지원되는 하나 이상의 언어로 작성된 코드에 대해 최고 품질의 설명서를 생성합니다. 다른 언어로 작성된 코드는 생성된 설명서에 반영되지 않거나 품질이 낮은 설명서를 생성할 수 있습니다. 언어에 대한 자세한 내용은 섹션을 참조하세요/doc를 사용한 설명서 생성에 대한 언어 지원.

  • 자연어로 README에 대한 특정 변경을 요청하려면 기존 README를 업데이트하도록 선택한 다음 특정 변경을 수행하는 옵션을 선택하여 요청할 수 있습니다. Amazon Q에서 설명서를 생성한 후 변경하고 Amazon Q에서 수행할 업데이트를 설명할 수도 있습니다.

  • Amazon Q에서 설명서에 적용하려는 업데이트를 설명할 때 다음을 고려하세요.

    • 변경 사항에 대한 설명에는 수정하려는 섹션, 추가 또는 제거하려는 콘텐츠, 수정이 필요한 특정 문제가 포함되어야 합니다.

    • 변경 사항은 프로젝트 기능이 README에 반영되는 방식과 관련이 있어야 합니다.

    • 참조하는 콘텐츠는 코드베이스에서 사용할 수 있어야 합니다.

  • Amazon Q는 프라이빗 또는 내부 플랫폼에 액세스할 수 없습니다. Amazon Q는 코드의 타사 도구, 소프트웨어 또는 특수 도구에 대한 지식이 없을 수도 있습니다. 코드에 Amazon Q가 액세스할 수 없거나 익숙하지 않은 리소스가 포함된 경우 해당 코드는 문서화되지 않습니다. Amazon Q가 생성할 수 없는 콘텐츠를 포함하도록 README를 수동으로 편집할 수 있습니다.