사용자 매뉴얼 작성하기

이 가이드에서는 새로운 사용자 매뉴얼을 작성하는 과정을 단계별로 안내합니다.

새 사용자 매뉴얼 생성하기

1. 문서 관리 화면에서 시작

사용자 매뉴얼 목록 화면에서 우측 상단의 "새 문서" 버튼을 클릭합니다.

2. 기본 정보 입력

문서 기본 정보를 입력합니다:

• 프로그램 ID: 문서가 설명하는 프로그램 또는 모듈의 고유 ID
• 프로그램 설명: 프로그램에 대한 간략한 설명
• 제목: 사용자 매뉴얼의 제목
• 대상 시스템: 매뉴얼이 적용되는 시스템
• 개발 언어: 구현에 사용된 프로그래밍 언어
• 모듈: 해당 프로그램이 속한 모듈
• 서브 모듈: 더 상세한 모듈 구분이 필요한 경우 입력

3. 요구사항 정보 입력

• 핵심 요구사항: 사용자 매뉴얼의 핵심 내용
• 추가 요구사항: 부가적인 내용이나 특이사항
• 변경 사유: 새 버전 작성 시, 이전 버전에서 변경된 사항에 대한 설명

시작하기 탭 작성

1. 리치 텍스트 에디터 사용하기

시작하기 탭은 매뉴얼의 주요 내용을 작성하는 공간입니다. 리치 텍스트 에디터를 사용하여 다양한 서식과 멀티미디어 요소를 포함한 콘텐츠를 작성할 수 있습니다.

에디터에서 사용할 수 있는 주요 서식 기능:

• 제목: 다양한 레벨의 제목 설정
• 텍스트 스타일: 굵게, 기울임, 밑줄, 취소선 등
• 목록: 순서 있는 목록, 순서 없는 목록
• 인용문: 인용 텍스트 블록
• 코드 블록: 코드 스니펫 삽입
• 표: 데이터를 표 형식으로 표시
• 링크: 내부/외부 링크 추가
• 이미지: 스크린샷 등 이미지 삽입

2. 효과적인 매뉴얼 구조 작성하기

일반적으로 사용자 매뉴얼은 다음과 같은 구조로 작성하면 효과적입니다:

# 프로그램명 사용자 매뉴얼

## 소개
- 프로그램 목적
- 주요 기능 개요

## 시작하기
- 접근 방법
- 로그인 절차
- 기본 화면 구성

## 주요 기능
- 기능 1: 설명 및 사용법
- 기능 2: 설명 및 사용법
  
## 작업 가이드
- 일반적인 작업 흐름
- 단계별 작업 지침

## 자주 묻는 질문(FAQ)
- 질문 1 및 답변
- 질문 2 및 답변

## 문제 해결
- 일반적인 오류 및 해결책
- 지원 요청 방법

3. 스크린샷 및 예시 추가

사용자의 이해를 돕기 위해 다음과 같은 시각적 요소를 추가하는 것이 좋습니다:

• 주요 화면 스크린샷
• 단계별 프로세스를 보여주는 이미지
• 버튼 및 컨트롤의 확대 이미지
• 실제 사용 예시 및 샘플 데이터

참조 문서 추가하기

1. 참조할 문서 검색 및 추가

헤더 영역의 문서 검색 필드를 사용하여 참조할 기능 사양서나 기술 사양서를 검색하고 추가할 수 있습니다.

1. 검색 필드에 문서 제목이나 ID를 입력합니다.
2. 검색 결과에서 원하는 문서를 선택합니다.
3. 선택한 문서가 새 탭으로 추가됩니다.

2. 참조 문서 설명 작성

각 참조 문서 탭에는 상단에 설명을 작성할 수 있는 텍스트 영역이 있습니다. 이 영역에는 해당 기능 사양서나 기술 사양서에 대한 컨텍스트 정보나 사용자가 알아야 할 추가 정보를 작성합니다.

설명 작성 예시:

이 섹션에서는 고객 주문 관리 화면의 사용법을 설명합니다. 주문 검색, 조회, 수정 및 취소 방법에 대한 상세 설명을 확인할 수 있습니다. 특히 주문 취소 시 필요한 권한과 승인 절차에 주의하세요.

3. 최신 버전 자동 사용 설정

참조 문서가 업데이트될 때 최신 버전을 자동으로 반영할지 여부를 설정할 수 있습니다.

• 항상 최신 버전 사용: 체크 시 참조 문서가 업데이트되면 자동으로 최신 내용을 반영
• 체크 해제: 현재 버전을 고정적으로 사용

4. 참조 문서 탭 관리

문서 참조 탭은 다음과 같이 관리할 수 있습니다:

• 탭 순서 변경: 현재 버전에서는 지원되지 않음
• 탭 삭제: 탭 이름 옆의 X 버튼 클릭
• 탭 이름: 참조 문서의 원래 제목이 사용됨

사용자 매뉴얼 저장

작성이 완료되면 우측 상단의 "저장" 또는 "저장 및 제출" 버튼을 클릭하여 문서를 저장합니다.

• 임시 저장: 작업 중인 문서를 임시 저장합니다.
• 검토 요청: 문서를 검토 단계로 전환합니다.
• 승인: 권한이 있는 경우 문서를 승인합니다.
• 완료: 문서 작성을 완료합니다.

미리보기 모드

작성 중 미리보기 모드를 사용하여 문서가 어떻게 표시될지 확인할 수 있습니다.

우측 상단의 눈 아이콘을 클릭하여 미리보기 모드와 편집 모드 사이를 전환할 수 있습니다.

작성 팁

사용자 중심 작성

• 기술 용어보다는 사용자가 이해하기 쉬운 일반 용어 사용
• 복잡한 기능은 단계별로 나누어 설명
• "~하세요", "~클릭하세요"와 같은 직접적인 지시문 사용
• 가능한 많은 스크린샷과 예시 추가

명확한 구조화

• 논리적인 순서로 정보 배치 (기본→고급, 일반→특수)
• 제목과 부제목을 효과적으로 사용하여 계층 구조 명확히 하기
• 중요한 정보는 눈에 띄게 강조 (굵게, 상자 등)
• 단계별 지침은 번호 매긴 목록으로 표시

참조 문서 효과적으로 활용하기

• 시작하기 탭에서는 전체 시스템의 개요와 공통 기능 설명
• 각 참조 문서에는 해당 기능의 사용 컨텍스트와 활용 사례 추가
• 참조 문서 간의 관계나 작업 흐름 설명
• 기술적 세부사항보다 사용자 관점에서의 기능 설명에 중점

이러한 가이드라인을 따라 작성하면 사용자가 시스템을 효과적으로 이해하고 활용할 수 있는 고품질 사용자 매뉴얼을 만들 수 있습니다.