소프트웨어 사용설명서는 전문용어 또는 기본적인 지식이 있어야 어느 정도 이해할 수 있는 지시사항으로 가득 찬 경우가 있습니다.

일반적으로 개발자의 관점에서 설명서가 작성되는 경우 사용자의 눈높이를 맞추지 못하는 경우가 종종 발생합니다. 그래서 일반적으로 이러한 사용설명서는 전문 기술문서 작성자인 테크니컬 라이터가 작성하게 됩니다.

 

기업에서 개발하는 소프트웨어에 대해서는 물론 개발자가 가장 잘 알고 있을 겁니다. 하지만 사용설명서를 작성하는 것은 소프트웨어를 이해하고 있는 것과는 다른 문제입니다.

소프트웨어나 일반 소비재 제품이나 사용설명서는 사용자가 제품을 쉽게 사용할 수 있도록 이해시키는데 그 목적이 있습니다.

 

[어떻게 사용자의 이해를 도울 수 있을까요?]

 

 

Apple redesigned many features in its popular iOS software, as shown off at WWDC. Screenshot by Shara Tibken/CNET

 

1] 기능이 아닌 작업을 중심으로 작성합니다.

소프트웨어 사용설명서는 기능에 대한 설명이 아니라 소프트웨어를 통한 작업 중심으로 작성해야 합니다. 설명서를 작성하는 테크니컬 라이터는 소프트웨어의 모든 기능에 대한 다양한 실무 지식이 있어야 합니다. 일반적으로 설명서를 작성하기 전에 라이터는 소프트웨어의 기능을 A부터 Z까지 전부 실행해봐야 합니다. 실제 사용한 경험을 바탕으로 작업의 단계별로 설명서를 작성합니다.

예를 들어 소프트웨어의 버튼 1개 기능의 설명이 아닌 해당 버튼을 사용하는 튜토리얼 형식으로 설명서를 작성합니다.

 

출처: Adobe Premier Pro 사용설명서

 

2] 스크린샷 이미지를 사용해서 설명합니다.

사용설명서에서 소프트웨어의 단계별 설명을 텍스트로만 작성하면 사용자는 도움을 얻기 전에 읽지 않을 것입니다. 사용설명서에서 가장 중요한 것 중 하나는 설명서의 이미지와 내가 보는 제품의 이미지를 동일하게 사용하여 설명하는 것입니다. 소프트웨어에서도 스크린샷을 사용하면 사용자가 보는 화면과 동일하게 볼 수 있으므로 더욱 명확하게 전달할 수 있습니다.

스크린샷은 사전 화면과 사후 화면을 모두 포함하여 사용자가 실행하기 전의 화면과 실행한 후의 결과를 보여줘야 합니다. 스크린샷은 화면 캡처 프로그램 또는 영상 캡처 프로그램을 사용해서 쉽게 이미지를 제작할 수 있습니다.

 

출처: DLC Vet Pty Ltd – DX-R Acquisition and Diagnostic Software User Manual

캡처한 이미지에 간단한 아이콘이나 지시선 또는 확대 이미지를 사용한다면 더욱 쉽게 전달할 수 있습니다.

만약에 스크린샷을 확대했을 때 부분의 이미지의 해상도가 떨어진다면 해당 부분에 대해서는 별도의 디자인 이미지를 제작해서 사용하는 것이 좋습니다.

 

3] 실시간 업데이트를 통한 사용자 만족도 증대

과거에 비해 최근 소프트웨어의 업데이트 주기는 상당히 빨라졌습니다. 해당 소프트웨어의 업데이트에 따라 사용 설명서에도 기능의 업데이트에 대해서도 설명을 즉시 해야 합니다.

업데이트에 대한 설명은 대부분 기존의 프로그램 사용자가 많아 부가적인 부분으로 생각할 수도 있지만 업데이트 버전을 구입하는 소비자도 간과해서는 안 됩니다.

 

출처: Wiki How to Update System Software on PS4

또한 소프트웨어의 부분 기능 업데이트라고 해서 해당 기능에 대한 설명만 업데이트하면 끝나는 것이 아닙니다. 가장 중요한 것은 해당 기능이 다른 작업 설명에 포함이 된다면 모든 부분을 찾아 업데이트해야 합니다.

예를 들어 확대 버튼이 A에서 B로 변경이 됐다면 확대 기능을 포함한 다른 작업 설명에서 확대 버튼에 대한 설명을 찾아 전부 바꿔줘야 합니다.

 

 

 

[사용자의 이해를 위해 포함해야 하는 것은?]

 

1) 튜토리얼

소프트웨어를 처음 접하는 사용자들에게는 설명서를 통해 소프트웨어를 단계별로 익히는 것이 필요합니다.

사용자가 소프트웨어를 사용해서 원하는 작업을 단계별로 진행하는 것을 보여줌으로써 신속하고 정확하게 소프트웨어를 이해할 수 있습니다.

 

 

2) 기능 설명

튜토리얼이 사용자가 특정 작업을 성공적으로 완료할 수 있도록 방향을 알려준다는 점에서 요리의 레시피와 비슷하다면 기능 설명은 소프트웨어에 좀 더 익숙한 사용자를 위해 기능에 대한 세부적인 설명과 옵션에 대한 설명을 추가합니다.

 

출처: DLC Vet Pty Ltd – DX-R Acquisition and Diagnostic Software User Manual

3) 참조 가이드

참조 가이드는 소프트웨어의 내부 코드 (API 등)에 대한 안내로 기본적인 소프트웨어에 맞춤형 설정을 할 수 있습니다. 다른 소프트웨어와의 연동 및 클라우드 웹 서비스와의 연동을 위해 응용 및 확장 방법에 대한 설명을 제공합니다. 소프트웨어의 특정 기능을 커스터마이징하는 방법 또는 외부의 기능을 불러오거나 소프트웨어의 기능을 외부로 연동하는 방법에 대해 안내합니다. 일반적으로 개발자 가이드 형식으로 제공됩니다.

 

출처: helpshift.com

4) 고급 사용 팁

고급 사용 팁은 사용 설명서에서 필수사항은 아니며 설명서 내의 작업 설명에서 추가적인 참고사항으로 작성되기도 합니다. 설명서 형식 및 소프트웨어의 기능에 따라 다양하게 활용할 수 있습니다. 예를 들어 소프트웨어의 특정 기능에 대해 숙련된 사용자가 응용할 수 있는 기능을 설명하기 위한 내용입니다.

 

출처: Unity Manual-Expert guides

 

이처럼 사용 설명서는 소프트웨어를 구매하는 소비자에게 제공되는 제품의 중요한 부분입니다. 소프트웨어를 소비자가 사용 목적에 맞게 사용하고 그 목적을 이룰 수 있도록 가이드를 제공하는 것이 사용설명서의 목표입니다.

소프트웨어 설명서는 온라인으로 제공되므로 업데이트가 쉽고 소비자가 매뉴얼을 어떻게 사용하는지 피드백을 받을 수 있습니다.

소프트웨어 사용 설명서에 대해 더 궁금하신 내용은 콘텐츠 제작팀으로 문의하시면 세부적으로 안내드리겠습니다.

감사합니다.

E-mail : content@textree.co.kr
TEL : 070-8270-8901