문제 해결 문서 템플릿
작성자: Atlassian팀
일반적인 문제와 해결 방법을 문서화하세요.
![문제 해결 문서 템플릿](https://wac-cdn.atlassian.com/dam/jcr:f9ecf0b7-2f50-4bac-9a13-eb0c3997eeb9/troubleshooting-article-preview-en.png?cdnVersion=2022)
문제 해결 문서를 작성하여 고객이 스스로 일반적인 문제를 다루고 해결책을 찾도록 도와주세요. Atlassian의 문제 해결 문서 템플릿은 문제를 표현하고, 해결책을 자세히 설명하며, 관련된 게시물을 표시(라벨 및 콘텐츠별 매크로를 사용하여 자동으로 표시하고 관련 게시물을 추적할 수 있음)할 수 있습니다. 물고기를 잡는 법을 가르쳐주고 지원팀에 더 복잡한 작업을 처리할 시간을 충분히 주세요.
문제 해결 게시물 템플릿을 사용하는 방법
1단계. 문제 설명
이러한 게시물이 있다면 바로 해결 방법으로 이동하고 싶을 수 있으나, 문제를 설명하는 것은 효과적인 콘텐츠를 작성하는 데 아주 중요한 부분입니다. 독자는 다루고 있는 문제에 대해 게시물이 직접적인 연관이 있는지 알 수 있어야 합니다. 대상 고객이 이 문제를 어떻게 경험하고 있는지 생각하고, 그러한 경험과 관련된 용어 및 예시를 사용하여 문제를 설명하세요.
2단계. 단계별 해결책 제공
문제를 설명했다면 해결 방법을 설명할 차례입니다. 번호가 매겨진 목록을 사용하여 단계별 해결책을 작성하세요. 독자가 알고 이해할 용어를 사용하고 한 번에 한 단계씩 작성하세요. 가능한 경우 단계를 그림으로 나타내세요. 그렇게 하면 게시물을 읽는 사람은 각 단계의 모습이 어때야 하는지 알게 됩니다. 가능한 해결책이 하나 이상인 경우, 가장 일반적인 해결책을 사용하는 것이 가장 좋습니다. 더 많은 옵션을 제공해야 한다고 생각하는 경우, 확장을 사용하여 닫을 수 있는 패널에 다른 해결책을 만들 수 있습니다.
3단계. 관련된 게시물 표시
가끔 비슷하지만 똑같지 않은 문제에 대한 게시물을 마주칠 수 있습니다. 그리고 해결책에 대해 더 잘 알면 이후의 문제를 방지하는 데 도움이 될 때도 있습니다. 문제 해결 게시물에 라벨을 적용하고 라벨 매크로(이 템플릿에 이미 포함됨)를 사용하여 관련된 게시물과 페이지를 자동으로 표시할 수 있습니다. 관련된 모든 페이지에 같은 라벨을 사용하도록 하세요.
Atlassian은 소프트웨어 개발자, 프로젝트 매니저 및 콘텐츠 관리를 위한 제품을 개발하는 엔터프라이즈 소프트웨어 기업입니다.
소프트웨어 개발/IT 템플릿 더 보기 모두 보기
-
Lucidchart
AWS 아키텍처 다이어그램
인프라를 시각화하여 약점과 개선이 가능한 부분을 더 잘 파악하세요.
-
Atlassian팀
이상적인 근무 주간 설계
작업 완료를 위한 단계별 지침을 제공하세요.
-
Atlassian팀
DevOps 런북
운영 팀이 시스템 알림 및 중단에 빠르게 대응할 준비가 되도록 하세요.