[화면설계서] 사용자 매뉴얼 작성법

완성된 IT 서비스를 운영하는 데 필요한 사용자 매뉴얼은 서비스 이용자들이 쉽게 이해하고 활용할 수 있도록 작성되어야 합니다. 사용자 매뉴얼은 기술적이지 않고 직관적이며, 사용자 경험을 고려해 구성하는 것이 중요합니다. 아래는 사용자 매뉴얼 작성법에 대한 단계별 가이드입니다.

사용자매뉴얼 샘플

1. 목차 구성

• 소개 (Introduction)
  • 서비스의 개요와 주요 기능을 간단하게 설명합니다.
• 시작하기 (Getting Started)
  • 초기 설정, 로그인 절차 등 서비스 사용을 위한 첫 단계 설명.
• 주요 기능 (Core Features)
  • 서비스의 핵심 기능을 카테고리별로 나누어 설명.

2. 매뉴얼 작성 시 고려사항

2.1. 사용자 중심의 언어 사용

• 기술적인 용어는 피하고, 이해하기 쉬운 일반적인 용어로 설명합니다.
• 단계별로 절차를 명확하게 설명하고, 각 단계마다 화면 캡처나 이미지를 추가합니다.

2.2. 단계별 가이드 작성

• 순서화: 사용자가 서비스를 처음 시작하는 시점부터 주요 기능을 이용하는 과정까지 순서대로 안내합니다.
• 기능별 설명: 각 기능을 세부적으로 설명하되, 각 기능의 목적과 활용 방법을 간단명료하게 기록합니다.
• 예시 제공: 텍스트 설명과 함께 구체적인 예시 화면 또는 상황을 제시해 사용자가 이해하기 쉽게 합니다.

2.3. 시각 자료 활용

• 스크린샷과 이미지: 실제 서비스 화면을 기반으로 한 스크린샷을 활용해 시각적으로 설명을 돕습니다.
• 동영상 자료 (필요 시): 복잡한 기능은 짧은 동영상으로 시연을 제공할 수 있습니다.

2.4. 문제 해결 섹션 작성

• 서비스 이용 중 발생할 수 있는 일반적인 문제와 그 해결 방법을 정리합니다.
• 문제를 카테고리별로 나누고, 가능한 구체적인 해결 절차를 제시합니다.
• 고객이 추가적인 지원을 받을 수 있는 방법을 안내합니다.

3. 주요 항목별 작성법

3.1. 소개 (Introduction)

• 서비스의 목적, 사용 대상자, 주요 기능을 간단히 설명.
• 사용자들이 이 매뉴얼을 통해 얻을 수 있는 내용을 명시.

3.2. 시작하기 (Getting Started)

• 회원가입 및 로그인 절차에 대한 상세한 설명.
• 시스템 요구사항과 접근 방법을 간단히 안내.
• 초기 설정이 필요한 경우, 필요한 모든 설정 단계를 설명.

3.3. 주요 기능 (Core Features)

• 기능을 설명할 때는 각 기능의 목적과 이를 이용하는 방법을 설명합니다.
• 예시: "검색 기능" → "검색창에 원하는 키워드를 입력 후 엔터를 누르세요.
  필터 기능을 사용해 검색 결과를 세분화할 수 있습니다."

3.4. 문제 해결 (Troubleshooting)

• 일반적인 오류 및 문제 상황과 그에 대한 해결 방법을 정리합니다.
• 예시: "로그인 오류가 발생할 경우, 비밀번호 재설정 링크를 클릭한 후 이메일 인증을 통해 비밀번호를 변경하세요."

4. 사용자 피드백 반영

• 매뉴얼 작성 후 실제 사용자들에게 테스트하고 피드백을 받아 개선합니다.
• 사용자들이 자주 묻는 질문이나 어려움을 겪는 부분을 반영해 내용을 추가하거나 수정합니다.

5. 포맷과 배포 방법

• 디지털 매뉴얼: PDF, 웹페이지, 모바일 앱 등의 형식으로 배포 가능.
• 동영상 매뉴얼: 시각적, 청각적으로 제공하여 복잡한 기능을 더 쉽게 이해하도록 도움.

매뉴얼은 서비스가 변경될 때마다 지속적으로 업데이트해야 하며, 사용자들이 쉽게 접근할 수 있는 곳에 배포하는 것이 중요합니다.

 

---

 

 

필수 항목

1. 표지

표지는 프로젝트 진행 시 제작한 스토리보드 표지와 동일하게 하거나 심플하게 만듭니다.

제목,버전,작성일자,클라이언트 로고는 포함되도록 합니다.

 

2. 목차

만들어진 스토리 보드 기준으로 목차를 정리합니다.

넘버링 + 항목 + 페이지 넘버를 포함합니다.

 

매뉴얼 작성

 

 

3. 히스토리

최종 산출물 제출시에는 해당 페이지는 없어도 되겠지만 작성시에는 여러사람이 작성을 할 수 있기에 해당 페이지를 유지합니다.

매뉴얼 작성

 

 

4. 간지

간지는 매뉴얼 항목이 많을 수록 간지가 없으면 어떤 페이지에 대한 내용인지 구분이 어려울 때 포함됩니다.

만약 작은 벌 수로 매뉴얼 페이지가 몇 페이지 안된다면 굳이 없어도 됩니다.

항목명 + 항목 하위 메뉴가 포함됩니다.

매뉴얼 작성

 

5. 내용

가장 중요한 콘텐츠 부분입니다.

화면명 + 화면경로 + 주요기능이 포함됩니다.

만들어진 프로젝트 타깃이 앱인지 PC인지에 따라 레이아웃은 고려하여야 합니다.

​

프로젝트 진행 디바이스가" 앱"이라면 앱화면이 세로로 길에 들어갈 수 있도록 사용법을 오른쪽에 기재합니다.

• 화면ID는 시나리오와 동일하게 작성합니다.(필수는 아니나 들어가는게 명확할 것 같습니다.)
• 2.4페이스북 로그인은 위에 설명드린 4번 간지에서 부타이틀 넘버를 기재하시면 됩니다.

매뉴얼 샘플

 

프로젝트 진행 디바이스가" PC"라면 앱화면이 가로로 길게 들어갈 수 있도록 사용법을 하단에 기재합니다.

 

매뉴얼 샘플

 

---

 

 

 

기획은 검정색입니다.

"졸업 가운의 색이 검정인 이유는 검정이 성취와 권력의 색이기 때문입니다."

 

질문 환영합니다. 댓글 남겨주세요.
thinkhub