수정 사항 보고¶
이 AWS 네트워킹 아키텍처 가이드는 여러 페이지로 구성되어 있으며, 기능, 구성 등에 관한 광범위한 정보를 포함하고 있습니다. 내용의 불일치를 발견하거나 개선이 필요한 부분을 발견하셨다면, 이 가이드를 따라 이슈 트래커에 이슈를 제출해 주세요.
이슈 템플릿¶
새 문서 수정 이슈를 생성하기 전에 이 가이드를 꼼꼼히 읽어보시고, 이슈에 다음 정보를 포함해 주세요:
- 제목
- 설명
- 관련 링크
- 제안된 변경 사항 (선택 사항)
제목¶
좋은 제목은 이슈를 간결하게 한 문장으로 설명하고, 관련 정보를 모두 포함하며, 특히 이슈 트래커에서 검색을 용이하게 하는 키워드를 담고 있어야 합니다.
| 예시 | |
|---|---|
| 명확함 | 멀티 클라우드 시나리오에서 DX 사용 방법 명확화 |
| 불명확함 | 문서에 정보 누락 |
| 무의미함 | 도움 필요 |
설명¶
문서에서 발견한 불일치 또는 이슈, 혹은 개선이 필요한 문서 섹션에 대해 명확하고 간결하게 요약해 주세요. 문서를 수정해야 한다고 생각하는 이유를 설명하고, 이슈의 심각도를 기술해 주세요:
-
간결하게 작성하세요 – 불일치 또는 이슈를 한두 문장으로 정확하게 설명할 수 있다면 더욱 좋습니다. 메인테이너와 향후 사용자들은 읽어야 할 내용이 적을수록 감사하게 생각할 것입니다.
-
한 번에 하나의 이슈만 – 서로 관련 없는 불일치를 여러 개 발견한 경우, 각각 별도의 이슈로 생성해 주세요. 하나의 이슈에 여러 문제를 함께 보고하지 마세요 – 어떤 보고가 어떤 문제에 대한 것인지 구분하기 어려워집니다.
이 정보가 필요한 이유: 문제를 명확하고 간결하게 설명하는 것은 문서를 개선하기 위한 전제 조건입니다 – 무엇이 잘못되었는지 이해해야 수정할 수 있습니다.
관련 링크¶
위에서 수정이 필요한 문서 섹션을 설명하셨다면, 이제 해당 문서 섹션과 관련 섹션의 링크를 공유해 주세요. 가능한 경우 앵커 링크(고정 링크)를 사용하면 내용을 찾는 데 도움이 됩니다.
이 정보가 필요한 이유: 문서 링크를 제공하면 수정, 보완 또는 전면 개편이 필요한 문서 섹션을 파악하는 데 도움이 됩니다.
제안된 변경 사항 선택 사항¶
설명과 문서 섹션 링크를 제공해 주셨다면, 개선 방안을 제안하여 저희(메인테이너)와 커뮤니티에 도움을 주실 수 있습니다. 대략적인 아이디어를 스케치하거나 구체적인 제안을 작성해 주세요. 이 항목은 선택 사항이지만 매우 유용합니다.
이 정보가 필요한 이유: 개선 제안은 동일한 이슈를 겪는 다른 사용자들에게 도움이 될 수 있습니다. 개선 제안은 메인테이너가 문서를 업데이트하기도 전에 해결책을 제공하기 때문입니다.
이후 작업은 저희가 진행하겠습니다.