Appearance
사용자 매뉴얼 관리하기
이 가이드에서는 사용자 매뉴얼의 관리, 검색, 상태 변경 등 문서 관리 방법을 설명합니다.
문서 목록 화면
문서 관리 화면에서는 모든 사용자 매뉴얼 목록을 확인하고 관리할 수 있습니다.
목록 화면 구성 요소
- 검색 필터: 문서 제목, 상태, 작성자 등으로 검색
- 정렬 옵션: ID, 제목, 변경 시간 등으로 정렬
- 문서 목록: 현재 등록된 사용자 매뉴얼 목록
- 확장 버튼: 문서의 버전 정보 확인
- 작업 메뉴: 각 문서에 대한 작업 옵션(편집, 복사, 삭제 등)
문서 검색 및 필터링
기본 검색
상단의 검색 필드를 사용하여 제목, 문서 ID, 작성자 등으로 문서를 검색할 수 있습니다.
고급 필터링
고급 검색을 사용하여 다음 조건으로 필터링할 수 있습니다:
- 문서 상태(초안, 검토 중, 승인됨 등)
- 작성자
- 작성 기간
- 시스템 코드
- 개발 언어
- 모듈
문서 상태 관리
각 문서는 다음과 같은 상태를 가질 수 있습니다:
- 초안(Draft): 작성 중인 문서
- 검토 중(In Review): 검토가 필요한 문서
- 승인됨(Approved): 검토 후 승인된 문서
- 거부됨(Rejected): 검토 후 수정이 필요한 문서
- 완료(Completed): 모든 과정이 완료된 문서
상태 변경하기
문서의 상태를 변경하려면:
- 문서 상세 화면에서 저장 버튼 옆의 드롭다운 메뉴를 클릭합니다.
- 변경하려는 상태를 선택합니다.
버전 관리
버전 목록 보기
문서 목록에서 확장 버튼을 클릭하면 해당 문서의 모든 버전을 확인할 수 있습니다.
각 버전에는 다음 정보가 표시됩니다:
- 버전 번호
- 상태
- 핵심 요구사항
- 추가 요구사항
- 작성자
- 변경 시간
버전 히스토리 보기
문서의 모든 버전 히스토리를 보려면:
- 문서 목록에서 해당 문서의 작업 메뉴(⋮)를 클릭합니다.
- "버전 히스토리" 옵션을 선택합니다.
버전 히스토리 화면에서는 각 버전의 상세 정보와 변경 내역을 확인할 수 있습니다.
특정 버전 보기
특정 버전의 상세 내용을 보려면 버전 번호를 클릭합니다. 이렇게 하면 해당 버전의 내용과 참조 문서를 볼 수 있습니다.
새 버전 생성하기
문서의 새 버전을 생성하려면:
- 문서 목록에서 해당 문서의 작업 메뉴(⋮)를 클릭합니다.
- "새 버전 추가" 옵션을 선택합니다.
- 새 버전에 대한 정보를 입력합니다.
- 핵심 요구사항
- 추가 요구사항
- 변경 사유
- 내용을 필요에 따라 수정합니다.
- 저장 버튼을 클릭하여 새 버전을 생성합니다.
문서 관리 작업
기본 정보 편집
문서의 기본 정보만 편집하려면:
- 문서 목록에서 해당 문서의 작업 메뉴(⋮)를 클릭합니다.
- "기본 정보 편집" 옵션을 선택합니다.
- 팝업 창에서 기본 정보를 수정한 후 저장합니다.
문서 버전 복사
특정 버전을 복사하여 새 버전을 생성하려면:
- 문서의 버전 목록에서 복사할 버전의 작업 메뉴를 클릭합니다.
- "복사" 옵션을 선택합니다.
- 새 버전에 대한 정보를 입력하고 저장합니다.
문서 삭제
문서를 삭제하려면:
- 문서 목록에서 해당 문서의 작업 메뉴(⋮)를 클릭합니다.
- "삭제" 옵션을 선택합니다.
- 확인 메시지에서 "삭제" 버튼을 클릭합니다.
주의
문서 삭제는 영구적이며 되돌릴 수 없습니다. 모든 버전과 참조 정보도 함께 삭제됩니다.
버전 삭제
특정 버전만 삭제하려면:
- 문서의 버전 목록에서 삭제할 버전의 작업 메뉴를 클릭합니다.
- "삭제" 옵션을 선택합니다.
- 확인 메시지에서 "삭제" 버튼을 클릭합니다.
주의
마지막 남은 버전은 삭제할 수 없습니다. 문서 자체를 삭제해야 합니다.
댓글 및 피드백 관리
댓글 보기
문서 상세 화면의 우측 패널에서 댓글을 확인할 수 있습니다.
댓글 추가
- 댓글 입력 필드에 내용을 입력합니다.
- "댓글 추가" 버튼을 클릭합니다.
댓글 응답
특정 댓글에 응답하려면 해당 댓글 아래의 "응답" 버튼을 클릭합니다.
중요 댓글 처리
작성자는 중요한 댓글을 표시하고 처리할 수 있습니다:
- 댓글 옆의 체크박스를 클릭하여 중요 댓글로 표시합니다.
- 필요한 수정을 완료한 후 다시 체크박스를 클릭하여 처리 완료로 표시합니다.
문서 내보내기
사용자 매뉴얼을 PDF 또는 HTML 형식으로 내보낼 수 있습니다:
- 문서 상세 화면에서 우측 상단의 "..." 메뉴를 클릭합니다.
- "내보내기" 옵션을 선택합니다.
- 원하는 형식(PDF 또는 HTML)을 선택합니다.
PDF 내보내기
PDF 내보내기는 모든 탭의 내용을 포함한 문서 전체를 내보냅니다. 이 형식은 인쇄용 문서나 오프라인 배포용으로 적합합니다.
HTML 내보내기
HTML 내보내기는 웹 브라우저에서 볼 수 있는 형식으로 문서를 내보냅니다. 이 형식은 온라인 배포나 인트라넷 게시용으로 적합합니다.
문서 공유 및 협업
문서 링크 공유
문서 링크를 복사하여 다른 사용자와 공유할 수 있습니다:
- 문서 상세 화면에서 브라우저의 URL을 복사합니다.
- 이메일이나 메시지를 통해 URL을 공유합니다.
사용자 그룹별 배포
사용자 매뉴얼은 대상 사용자 그룹에 따라 다르게 구성하여 배포할 수 있습니다:
- 일반 사용자용: 기본 기능과 일반적인 작업 흐름에 중점
- 고급 사용자용: 고급 기능과 심화된 활용법 포함
- 관리자용: 관리 기능과 시스템 설정에 대한 내용 포함
업데이트 알림
문서가 업데이트될 때 사용자에게 알림을 보내는 것이 좋습니다:
- 이메일이나 시스템 내 알림을 통해 업데이트 소식 공유
- 중요한 변경 사항 요약 제공
- 새 버전 링크 제공
문서 품질 관리
정기적인 검토
사용자 매뉴얼의 품질을 유지하기 위해 정기적인 검토를 수행하세요:
- 분기별 또는 새 릴리스마다 내용 검토
- 스크린샷과 예시가 최신 UI와 일치하는지 확인
- 링크와 참조가 올바르게 작동하는지 확인
- 사용자 피드백을 반영하여 불명확한 부분 개선
사용자 피드백 수집
사용자 매뉴얼의 효과성을 평가하기 위한 피드백을 수집하세요:
- 문서 끝에 피드백 링크나 폼 제공
- 정기적인 사용자 설문조사 실시
- 지원 문의 분석을 통한 문서 개선점 파악
이러한 관리 기능을 활용하면 사용자 매뉴얼을 효율적으로 관리하고 사용자에게 항상 정확하고 유용한 정보를 제공할 수 있습니다.
