문제 해결 토픽 유형

문제 해결 토픽은 페이지의 마지막 토픽이어야 합니다.

페이지에 다섯 개 이상의 문제 해결 토픽이 있는 경우, 해당 토픽들을 별도의 페이지에 넣으세요.

포함해야 할 문제 해결 정보 유형

문제 해결 정보에는 다음이 포함됩니다.

이러한 종류의 콘텐츠는 다른 사람들에게 유용할 수 있으며, 혜택이 리스크를 상회합니다. 이 규칙에 예외가 있다고 생각되면 기술 문서 작성팀에 연락하세요.

GitLab 지원팀은 자체 문제 해결 콘텐츠를 유지보수합니다.

문제 해결은 소개, 작업, 또는 참조 중 하나일 수 있습니다.

이 토픽은 페이지의 문제 해결 섹션을 소개합니다. 예를 들어:

## 문제 해결

<x 기능>을(를) 사용하는 동안 다음과 같은 문제가 발생할 수 있습니다.

제목은 표준 작업과 유사해야 합니다. 예를 들어, “디버그 도구 실행” 또는 “구문 검증 확인.”

이 토픽에는 오류 메시지가 포함됩니다. 일관성을 유지하기 위해 일시적 해결책에는 workaround를 사용하고 영구적인 해결책에는 resolution 및 resolve를 사용하세요. 예를 들어:

### 오류 메시지 또는 해당 설명

<오류 메시지>라는 오류가 발생할 수 있습니다.

이 문제는... <br> 일시적 해결책은...

여러 원인 또는 해결책이 존재하는 경우, 이를 테이블 형식으로 정리하는 것을 고려하세요. 정확한 오류 메시지를 사용하는 경우, 코드로 스타일이 지정되도록 역따옴표로 둘러십니다.

해결책 유형에 대한 자세한 지침은 workaround 및 resolution, resolve을 참조하세요.

문제 해결 참조 토픽의 제목에 대해 다음을 고려하세요:

제목에 완전한 오류를 포함하지 않는 경우, 본문 텍스트에 포함하세요.

문제 해결 제안에 GitLab 인스턴스의 데이터를 변경하는 함수가 포함된 경우, 다음 경고를 추가하세요:

WARNING:
데이터를 변경하는 명령은 올바르게 실행되지 않거나 적절한 조건하에서 실행되지 않는다면 손상을 일으킬 수 있습니다. 항상 명령을 먼저 테스트 환경에서 실행하고 복원할 수 있는 백업 인스턴스가 준비되어 있는지 확인하세요.

페이지에 문제 해결 토픽이 다섯 개 이상이 있는 경우, 별도의 문제 해결 페이지 유형을 만드세요.

다음 규칙을 따르세요: