가이드 또는 절차 문서의 문제 해결 구역을 사용하여 해답을 절차에 가깝게 유지하세요. 지원 및 제품 관리자와 협력하여 일반적인 오류를 표시하고 설명서에 포함하세요.
알려진 문제
알려진 이슈는 버그, UX/UI 문제 및 많은 양의 지원 티켓을 생성하는 기타 제품 단점에 대응하도록 특별히 설계된 콘텐츠 문제 해결의 하위 집합입니다. 콘텐츠 문제 해결에서 사용자에게 발생_할 수 있는_ 오류를 설명하는 반면, 알려진 이슈는 사용자들이 겪게 될 이슈를 설명합니다.
모든 문제 해결 콘텐츠와 마찬가지로 알려진 이슈는 문서 또는 독립 실행형 문서의 구역일 수 있습니다. 알려진 이슈가 특정 문서에 적용되는 경우 해당 문서에 문서화합니다. 알려진 이슈가 특정 문서 집합 또는 기능의 개념적 그룹화에 적용되거나 제품 또는 기능에 함께 그룹화해야 하는 여러 알려진 이슈가 있는 경우 전용 ‘NAME 관련 알려진 이슈슈’ 문서를 만드세요.
제품 또는 기능에 대한 알려진 이슈 콘텐츠는 포괄적일 필요가 없습니다. 다른 문제 해결 콘텐츠와 달리 일부 알려진 이슈에는 해결 방법이 없을 수 있습니다. 해결 방법 없이 이슈를 문서화하는 목적은 GitHub이(가) 이미 해결 방법이 없다고 판단한 후 문제가 있는지 확인하고 아직 존재하지 않는 해법을 검색하는 시간을 절약하는 것입니다.
제품 및 기능 소유자(PM 및 EM)는 알려진 이슈 콘텐츠를 계획하고 검토하는 데 도움이 됩니다.
알려진 이슈를 사용하여 다음 상황을 설명하세요.
- 정기적으로 사람들의 기대에 상반되지만 아직 수정에 우선 순위가 지정되지 않은 제품 동작.
- 일반적인 용도로 제품 또는 기능의 사용을 정기적으로 방지하는 동작.
- GitHub이(가) 아직 수정의 우선 순위를 지정하지 않았으며 제품이나 GitHub Docs의 기존 콘텐츠에 설명되지 않은 희귀하거나 심각한 버그.
문제 해결 콘텐츠 작성 방법
- GitHub Docs 콘텐츠 형식을 사용하여 문제 해결 구역을 만드세요.
- 가능하면 절차 콘텐츠 또는 가이드에 포함된 콘텐츠의 문제를 계속 해결하세요.
- 특정 항목에 많은 양의 문제 해결 콘텐츠가 있는 경우와 같이 별도로 유지하는 것이 합리적일 때, 문제 해결 문서를 만들 수 있습니다.
- 제품 또는 기능에 ‘AUTOTITLE’의 예시처럼 많은 문제 해결 문서가 있는 경우 문제 해결 맵 토픽을 만들 수 있습니다.
콘텐츠 문제 해결을 위한 제목 지침
- 기능 문제 해결
- 오류: 오류 이름
- PRODUCT의 알려진 이슈
콘텐츠 문제 해결의 예시
- "SSH 문제 해결"
- "부하 분산 장치로 GitHub Enterprise Server 사용"
- GitHub Enterprise Server 릴리스 정보에서 ‘알려진 이슈’
- "오류: SSH 키 감사를 수행하고 있음"