설명서와 도움말

만들려고 하는 문서가 설명서인가요? 도움말인가요? 우리가 작성하는 설명서나 도움말은 한쪽으로 조금 더 기울어져 있을 뿐 설명서와 도움말의 성격을 모두 갖고 있는 경우가 많습니다.

그렇다면 설명서와 도움말의 차이점은 무엇일까요? 설명서와 도움말의 차이는 “무엇(What)”과 “어떻게(How)”의 비중에 있습니다. 설명서에는 제품을 어떻게(How) 사용하는지에 대한 설명도 들어있지만 제공하는 제품의 모습과 특징, 장점 등 대상이 무엇(What)인지를 잘 알 수 있도록 설명하는 글이 많습니다. 반면, 도움말은 제품을 어떻게(How) 사용하는지, 문제가 발생했을 때 어떻게(How) 해결하는지를 알려 주는 글이 많습니다. DITA에 빗대어 보면 도움말은 Task 토픽으로 구성된 문서입니다. Task 토픽과 Reference 토픽이 적절하게 구성된 문서는 설명서라 할 수 있습니다.

사용자 관점에서 설명서와 도움말을 구분할 수도 있습니다. 대부분 설명서는 “특정 분야”에 깊은 지식을 지닌 (또는 갖고자 하는) 전문가 집단을 대상으로 합니다. 도움말은 다양한 특색을 지닌 일반 사용자를 대상으로 합니다. 성능 모니터링 솔루션인 제니퍼는 설명서가 필요하고, 사내 그룹웨어 시스템에는 도움말이 필요합니다. 개발자 그룹이 주로 사용하는 깃허브(GitHub)에는 설명서가, 다양한 사용자를 대상으로 하는 페이스북은 도움말이 필요합니다. 부연하면 대상의 “난이도”에 따라 설명서와 도움말을 구분합니다. 복잡한 대상에는 설명서가, 쉬운 대상에는 도움말이 필요합니다.

상술한 바와 같이 사용자 관점에서 보면 MS워드에는 도움말보다는 설명서가 필요합니다. 대부분의 사람들이 사용하기는 하지만 MS워드는 꽤 난이도가 있고 전문성을 필요로 하기 때문입니다. 다수의 워드 사용자들을 전문가 집단으로 볼 수 있습니다. 하지만 워드 사용자에게 MS워드가 무엇인지에 대한 설명보다는 사용 방법이나 문제 해결 방법을 알려 주는 데 더 비중을 두어야 한다는 관점에서 보면 설명서보다는 도움말이 맞습니다. 그렇기에 문서 작성자는 만들고자 하는 문서의 성격을 제대로 인지하고 있어야 합니다.

만들고자 하는 문서가 설명서입니까? 도움말입니까? 만들고자 하는 문서가 무엇(What)과 어떻게(How) 중 어느 것에 더욱 비중을 두고 있는지, 어떤 사용자 계층을 타깃으로 하는지를 먼저 생각한다면 그 목적에 가까운 문서를 만들게 될 것입니다.