소프트웨어 사용자 매뉴얼 / 설명서 작성 방법

 

 

 

 

오늘은 문서 작성 업무가 생겨서,

SW문서 작성법/ 테크니컬라이팅의 기본 지식에 대해 알아보자.

 

 

 

---

 

 

✅ 사용자 매뉴얼 ? 

사용자가 소프트웨어를 사용하는 과정에서 필요한 내용을 문서로 기록한 설명서와 안내서

 

 

 

✅ 사용자 매뉴얼은 왜 필요할까

• 매뉴얼을 통해 초보자도 빠르게 적응할 수 있다. 
• 올바른 사용법을 안내한다.
• 업무의 효율성이 향상된다. 
• 표준 / 일관성이 유지 될 수 있다. 

 

 

 

오늘은 매뉴얼 작성시 전반적인 팁부터, 매뉴얼에 필요한 내용, 매뉴얼 테스트 등  

전반적인 것을 알아보자. 

 

---

 

 

사용자 매뉴얼 작성을 위한 전반적인 팁 

 

✅ 작업 중심으로 작성하기 

 

기능에 대한 설명이 아니라, 소프트웨어를 통한 작업 중심으로 작성해야한다. 

 

이를 위해서  문서작성자는 소프트웨어에 대한 모든 기능을 A부터 Z까지 실행해봐야한다. 

실제로 사용한 경험을 토대로  작업의 단계별로 설명서를 작성한다. 

 

 

예를 들어 특정 버튼1개에 대한 설명보다는

버튼을 통해 어떻게 넘어가는지 과정을 기술하여 튜토리얼 형식으로 작성할 수 있다. 

 

 

✅ 이미지를 잘 사용하자. 

사진 / 이미지를 잘 사용해야하는 이유

•  글씨만 있으면 가독성이 떨어진다.
•  사용자에게 동일한 화면을 가이드 안에 보여줬을때 더 쉽게 이해할 수 있다. 

 

 

설명서에 들어갈 이미지는  내가 실행시켜본 이미지를 동일하게 사용해 설명해야한다. 

실행하기 전과 실행한 후의 결과를 모두 보여줘야한다.

 

• 필요한 경우 ▶  화살표/  ⏺ 원  등으로 중요한 부분 강조하기  
• 최신 버전의 인터페이스를 반영하기

 

💥 아이콘 사용

일괄된 아이콘을 사용하면 좋다!

 

⚠️ 주의: 이 설정은 되돌릴 수 없습니다.
💡 팁: 더 나은 성능을 위해 캐시를 주기적으로 삭제하세요.
🔒 보안: 이 정보는 암호화되어 저장됩니다."

 

 

⏹  순서도 / 프로세스 다이어그램 

복잡한 프로세스/ 워크플로우 설명시에 효과적이다. 

단계를 명확히 구분하고, 화살표로 연결한다. 

 

 

 

✅ 고급 응용 가이드

사용자의 수준은 다양하다.

아예 모르는 초보자부터 해당 도구를 잘 알고 응용하는 사용자까지.

 

너무 난이도가 낮은 수준의 가이드만 있으면 전문가가 볼 필요가 없기 때문에 

숙련된 사용자가 응용할 수 있는 기능을 설명하기 위한 내용을 추가로 작성한다.

 

 

고급 기능의 방법을 엄청 구체적으로 적을 필요는 없다.

어떤 방향이 있는지 어떤 기능이 있는지 설명해주면 된다.

 

 

✅ 전체적인 매뉴얼 작성시 팁 

1. 소프투웨어 사용에 필요한 절차 / 제반사항등이 포함되도록 작성한다.

2. 발생될수있는 오류 에 대한 패치 / 기능에 대한 업그레이드를 작성한다.

3. 개별적으로 동작이 가능한 컴포넌트 단위로 매뉴얼 작성 한다.

4. 목차 개요 서문 기본사항 등이 포함되어야한다. 

    ( 목차 = 매뉴얼 전체내용을 순서대로 요약 후 관련 내용의 시작 페이지를 기술한다. )

5. 소프트웨어의 특징, 매뉴얼의 구성, 실행방법, 사용법, 설정 방법 등을 기술 한다.

6. 설정 지침, 사용 지침, 문제 해결 팁 및 안전 경고가 포함되어야 한다. 

 

 

항목	설명
소프트웨어 개요	소프트웨어의 주요 기능 및 UI 설명, UI 및 화면 상의 버튼, 프레임 등을 그림으로 설명
소프트웨어 사용 환경	소프트웨어 사용을 위한 최소 환경 설명, CPU 메모리 등의 PC 사양 운영체제(OS) 버전 설명, 최초 구동에 대한 설명, 소프트웨어 사용 시 발생할 수 있는 프로그램 충돌이나 개인정보 보안 등에 관한 주의사항을 설명한다.
소프트웨어 관리	소프트웨어의 사용 종료 및 관리 등에 관한 내용 설명
모델, 버전별 특징	모델 및 버전별로 UI 및 기능의 차이점을 간략하게 요약한다.
기능, 인터페이스의 특징	제품의 기능과 인터페이스의 특징을 간략하게 요약한다.
소프트웨어 구동 환경	개발에 사용한 언어 및 호환 가능한 운영체제(OS)에 대해 설명한다, 설치 후 구동하기까지의 과정을 운영체제(OS)별로 설명한다.

 

 

 

---

 

 

 

✅ 가이드 작성 전 생각해볼 부분

 

# 사용자 정의

사용자는 누구인가 ?

제품을 어느정도 알고 있는가? 

사용자에게 필요한 부분이 어디인가?

사용자가 요구하는 내용이 무엇인가?  

 

 

• 인터페이스를 이용하는 개발자
• 인터페이스를 생성하는 개발자 
• DB FTP HTTP 연결을 해야하는 사람 
• 기본적인 개발지식과 인터페이스 이용을 해본 사람이라고 가정

 

 

✅ 가이드 작성 절차 

 

1. 표지

표지는 깔끔하게 만들어야 하고, 기본적인 내용을 추가한다. 

• 제품/서비스 이름
• 매뉴얼 버전/ 발행일
• 회사로고 

ex) 

• 제목  : 인터페이스 연계 방법
• v.01  발행일 2025-03-18

 

 

2. 목차 

매뉴얼은    구조를 한눈에 파악할 수 있어야한다.   +    특정 정보에 대한 접근성이 좋아야한다.   

이를 위해 아래 세가지가 중요하다. 

 

• 명확한 제목
• 계층적 구조 
• 빠른 접근을 위해  [ 페이지 번호, 하이퍼링크] 제공 

 

 

 

3. 제품에 대한 개요

서비스의 전반적인 모습과 주요 구성요소를 설명한다. 

• 제품의 주요 부분/ 핵심요소 설명
• 각 부분이 담당하는 기능 간단하게 설명
• 서비스의 흐름도 / 도면 등

 

TMAX  사의 Anylink의 경우는 

Studio, WebAdmin, DIS, RTE등이 있는데

 

각 구성요소가

• 어떻게 연결되어있고
• 어떤 역할을 담당하고
• 어떤것을 할 수 있는지

간단하게 설명해주면 된다. 

 

 

 

4. 기본 사용방법 

# 사용자 화면 / UI 

화면이 어떤것을 의미하고, 어떤 기능을 사용할 수 있는지 전체적인 것 기술 

 

- 개발자의 관점에서 어떤 곳을 봐야하는지

- 설계자의 관점에서 어떤 곳을 봐야하는지

- 에러나 오류 상황시 어떤곳을 봐야하는지  등

 

 

#  실제 필요한 내용  (매뉴얼의 목적) 

 

 

ex  애니링크를 통한 연동방법 기술  -  버튼 및 추가 방법 등 객체를 보는 방법 

  가)  FTP / DB / HTTP 연동방법 기술 

 

 ▶ 튜토리얼 (쉬운버전)

- 따라가면서 만들 수 있는 정도의 수준 

             >> 튜토리얼 중 만나는 문제도 해결방법까지 모두 기록한다. 

 

 

 ▶  어려운버전   

- 기본버전에 추가로 넣을 수 있는 것들

-  에러 발생시 어디를 보고, 어떤 분석을 하고 ...  >> 중간에 이상 발생시 메세지 및 에러에 대한 내용을 분류해 설명환다. 

- 내가 만난 연동시 나오는 문제들을 붙혀넣어서 예시 만들어주기

• 고급 설정 옵션 설명
• 전문가용 기능 소개
• 커스터마이징 방법
• 성능 최적화 팁

 

  나)  엑셀로 어떻게 하는 방법 기술

 ▶  튜토리얼 (쉬운버전)

 ▶  어려운버전

 

 

 

 

 # 추가로 생각해볼 부분 

- 수동/반복되는 업무의 경우 없앨 수 있는 방법은?

- 자주 사용하는 단축키가 있는가? 

- 설정을 변경하는 방법은? 

- 사용중에  발생할 수 있는 일반적인 문제와 그 해결 방법을 제공한다.

• 문제 증상 설명
• 가능한 원인
• 단계별 해결 방법
• 추가 지원이 필요한 경우 연락 방법

-  문제의 심각성에 따라 색상 코드를 사용하여 구분하는것도 좋은 방법

 

5. 표준 정의 

표준이나, 정석적인 방법을 기록해야한다. 

 

* SW사용 가이드 사용방법의 표준을 정의하면 

사용자별로 다르게 작성해서 발생하는 문제를 줄일 수 있지 않을까? 

 

 

>>  현재 개발자 여러명이 각각 추가하는 식으로 될거라서 표준이 없으면 나중에 문제가 될 수 있을것 같은데

그런 표준을 정의해두면 좋지 않을까? 

 

 

 

 

6. (Option) 용어 설명 

용어가 많을 경우 용어 설명 파트를 분리해 추가한다.

매뉴얼에서 사용된 전문 용어나 약어를 설명한다. 

 

• 가나다 / 알파벳 순서로 정렬한다.
• 각 용어에 대해 간단하고 명확한 정의를 제공한다. 

 

 

 

7. 참조 가이드 / 블로그 기술 

• 추가 도움이 필요한 경우 연락할 수 있는 지원채널/정보를 제공한다. 
• 기술블로그의 링크를 제공한다. 

 

 

---

 

✅  메뉴얼 테스트

가이드 완성 전에 매뉴얼을 사용하여 효과를 1차로 테스트한다. 

 

• 피드백 채널의 다향화  >>  다양한 특징의 사용자 피드백을 받는다. 
• 피드백 받을 내용
  • 매뉴얼과 상호작용을 관찰하고, 명확성, 유용성, 이해력에 대한 피드백 요청하기
  • 사용 후 개선이 필요한 부분이나 주제가 있는지 물어보기
• 많은 사용자가 언급한 문제들을 해결해 줄 수 있어야한다. 
  • 어떤 내용이 이해가 잘 안된다  ->  이해가 안되는 부분을 더 디테일하게 설명한다.  

 

 

 

 

 

---

 

 

 

✅ 글 작성시 팁 모음 

 

문장은 짧고 쉽고 간단하게!

• 간단한 일상단어 사용하기 
• 짧고 명확한 문장쓰기
• 한문장에 하나의 아이디어만 담기

 

능동태 사용하기 - 직접 지시하는 것처럼 

"홈 화면에서 설정 메뉴를 찾으세요."

 

 

일관된 용어 사용하기

> 같은 개념/기능을 지칭할 때 동일한 용어를 사용하라

다양한 표현 사용시 사용자가 혼란스럽다. 

 

 

전문 용어의 설명

처음 등장시 간단한 설명을 제공한다.  

 

긍정문을 사용한다.

부정문은 이해하기 어렵다. 

• 비밀번호를 만들 때엔 영문자만 사용하는건 피해야합니다.  (X)
• 비밀번호를 만들 때엔 영문자, 숫자, 특수문자를 조합해서 만들어주세요. (O)

 

 

복잡한 개념/ 절차를 설명할 때는 구체적인 예시를 사용한다. 

"강력한 비밀번호를 만드세요. 예를 들어, 'I love coffee!'대신 'iL0v3C0ff33!'와 같이 문자, 숫자, 특수문자를 조합하세요."

 

사용자 중심의 언어 사용하기 

우리/ 회사 보다는   당신/사용자 같은 표현을 사용한다. 

 

 

 

---

 

References 

 

https://textree.co.kr/blog/software_manual_0722

소프트웨어 사용설명서는 어떻게 제작할까요?

 

 

https://velog.io/@clay/%EC%86%8C%ED%94%84%ED%8A%B8%EC%9B%A8%EC%96%B4-%EC%82%AC%EC%9A%A9%EC%9E%90-%EB%A7%A4%EB%89%B4%EC%96%BC-%EC%9E%91%EC%84%B1

소프트웨어 사용자 매뉴얼 작성

 

 

https://blog.naver.com/textreeb2b/221796171065

소프트웨어 사용자 설명서 작성 방법

 

https://tussle.tistory.com/136

정보처리기사 필기(제품 소트프웨어 패키징)소프트웨어 사용자 매뉴얼 작성

 

https://www.jaenung.net/tree/801

 

 

 

예시 

https://download.brother.com/welcome/docp000768/ptp700_kor_soft.0.pdf

https://download.brother.com/welcome/docp000448/cv_ql700_kor_soft_a.pdf