[비즈니스] Troubleshooting 문서 쓰기 / Troubleshooting이란? (수정중)

Troubleshooting이란?

- Troubleshooting은 문제해결 과정의 형식을 말함.

- 목적은 보통, 기계 혹은, 시스템에서의 하자있는 생산품 혹은 프로세스들 고치기 위해 사용됨.

- Troubleshooting은 증상을 구체화하는데 필요함. (중요)

- 가장 가능성이 높은 원인을 결정하는 것은 제거 과정(process of elimination)을 통해서 함.

(문제의 잠재적인 원인을 제거해버림)

https://en.wikipedia.org/wiki/Troubleshooting

 

Troubleeshooting을 작성하기 위한 목차는 아래와 같다.

 

간단한 작성방법 1

1. 문제

2. 원인

3. 해결방법

 

간단한 작성방법 2

1. 증상

2. 원인

3. 해결방법

 

 

(한글버전)

문제

- 보통, 누가, 무엇을, 언제, 그리고 어디서를 쓴다.

* 사용자가 무엇을 해결하려고 하는지, 명확하고 정확한 개요를 쓴다.

* 

 

원인

 

해결방안

 

 

 

 

참고자료

https://docs.newrelic.com/docs/style-guide/article-templates/troubleshooting-docs-guide/

 

- 버그리포트 쓰는 방법

https://i5i5.tistory.com/621?category=1143381 

[비즈니스] (이슈 알리기) 버그리포트 (Bug report) 잘쓰기 위한 7가지 항목