문제 해결 항목 유형

문제 해결 항목은 페이지의 마지막 항목이어아 합니다.

만약 페이지에 다섯 개 이상의 문제 해결 항목이 있다면, 이러한 항목들을 별도의 페이지에 넣으십시오.

포함해야 하는 문제 해결 정보의 유형

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

이러한 종류의 콘텐츠는 다른 사람에게 도움이 될 수 있으며, 이득이 위험을 상회합니다. 만약 여기의 규칙에 예외가 있다고 생각된다면 기술 문서팀에 연락하십시오.

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

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

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

## 문제 해결

<x 기능>과(와) 작업 시, 다음과 같은 문제가 발생할 수 있습니다.

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

이 주제에는 메시지가 포함됩니다. 일관성을 유지하기 위해 기록된 해결책을 위해 일시적인 해결책에는 workaround를, 영구적인 해결책에는 resolution 또는 resolve를 사용하십시오. 예를 들어:

### 메시지 또는 그에 대한 설명

<오류 메시지>와 같은 오류가 발생할 수 있습니다.

이 문제는 ... 때문에 발생합니다.

일시적인 해결책은 ...

여러 원인이나 해결책이 있는 경우, 표 형식으로 정리하는 것을 고려하십시오. 정확한 오류 메시지를 사용한다면, 코드스타일로 출력되도록 백틱으로 둘러십시오.

해결책 유형에 대한 자세한 지침은 workaround 및 resolution, resolve을 참고하십시오.

문제 해결 참조 주제의 제목으로 다음을 고려하십시오:

적어도 일부 출력 메시지를 포함하는 것을 고려하십시오. 메시지가 70자 이상이라면 가장 중요한 텍스트를 포함하거나 대신, 메시지를 설명하십시오.
제목의 시작에 메시지 유형을 명시하십시오. 이것은 심각성을 나타냅니다. 예를 들어, 오류:, 경고:.
제목에 링크를 사용하지 마십시오.

제목에 완전한 메시지를 넣지 않은 경우, 본문 텍스트에 포함하십시오. 예를 들어:

## 오류: `unexpected disconnect while reading sideband packet`

불안정한 네트워크 환경은 주 서버에서 대규모 저장소 데이터를 가져오려고 Gitaly가 실패하게 할 수 있습니다. 이러한 상황은 ...

문제 해결 제안에 GitLab 인스턴스 데이터를 변경하는 함수가 포함되어 있는 경우, 다음 경고를 추가하십시오:

경고:
데이터를 변경하는 명령은 올바르게 실행되지 않거나 올바른 조건 하에서 실행되지 않을 경우에 손상을 일으킬 수 있습니다. 항상 먼저 시험 환경에서 명령을 실행하고 복원할 수 있는 백업 인스턴스가 준비되어 있는지 확인하십시오

한 페이지에 문제 해결 주제가 다섯 개 이상 있을 경우, 별도의 문제 해결 페이지 유형을 만드십시오.

다음 규칙을 따르십시오: