Skip to content

사용자 매뉴얼 편집하기

이 가이드에서는 기존 사용자 매뉴얼을 편집하고 업데이트하는 방법을 안내합니다.

문서 편집 모드 진입하기

1. 문서 목록에서 편집할 문서 선택

문서 관리 화면에서 편집하려는 사용자 매뉴얼을 클릭하여 상세 보기로 이동합니다.

2. 편집 모드 전환

상세 보기 화면에서 우측 상단의 "편집" 버튼을 클릭하여 편집 모드로 전환합니다.

기본 정보 수정

"상세 정보" 아코디언을 클릭하여 기본 정보 섹션을 열고 필요한 정보를 수정합니다.

본문 내용 편집하기

리치 텍스트 에디터 사용

시작하기 탭에서 리치 텍스트 에디터를 사용하여 본문 내용을 편집할 수 있습니다.

에디터 도구 모음을 사용하여 다음과 같은 서식을 적용할 수 있습니다:

  • 텍스트 서식: 제목 레벨, 굵게, 기울임, 밑줄 등
  • 목록: 순서 있는 목록, 순서 없는 목록
  • 인덴트: 들여쓰기, 내어쓰기
  • 정렬: 왼쪽, 가운데, 오른쪽 정렬
  • 특수 블록: 인용문, 코드 블록
  • 링크: 하이퍼링크 추가/수정
  • 미디어: 이미지, 표 등 삽입

이미지 추가 및 관리

본문에 이미지를 추가하려면:

  1. 이미지를 추가할 위치에 커서를 놓습니다.
  2. 에디터 도구 모음에서 이미지 버튼을 클릭합니다.
  3. 이미지 URL을 입력하거나 이미지 파일을 업로드합니다.
  4. 이미지 크기와 정렬을 조정합니다.

이미지를 편집하려면:

  1. 이미지를 클릭하여 선택합니다.
  2. 이미지 속성 패널에서 크기, 정렬, 대체 텍스트 등을 수정합니다.

표 추가 및 관리

표를 추가하려면:

  1. 표를 추가할 위치에 커서를 놓습니다.
  2. 에디터 도구 모음에서 표 버튼을 클릭합니다.
  3. 행과 열 수를 선택합니다.
  4. 표가 삽입되면 셀에 내용을 입력합니다.

표를 편집하려면:

  1. 표 내에 커서를 놓습니다.
  2. 우클릭하거나 도구 모음에서 표 관련 옵션을 선택합니다.
  3. 행/열 추가 또는 삭제, 셀 병합 또는 분할 등의 작업을 수행합니다.

참조 문서 관리

참조 문서 추가

편집 모드에서 새로운 참조 문서를 추가하려면:

  1. 헤더 영역의 문서 검색 필드를 사용합니다.
  2. 검색 결과에서 원하는 문서를 선택합니다.
  3. 선택한 문서가 새 탭으로 추가됩니다.

참조 문서 설명 편집

각 참조 문서 탭의 상단 텍스트 영역에서 설명을 편집할 수 있습니다:

이 설명에는 해당 기능 사양서나 기술 사양서에 대한 컨텍스트 정보나 사용 지침을 작성합니다.

참조 문서 버전 설정 변경

참조 문서의 버전 설정을 변경하려면:

  1. 참조 문서 탭을 선택합니다.
  2. 우측 상단의 체크박스를 사용하여 "항상 최신 버전 사용" 옵션을 켜거나 끕니다.
    • 체크 시: 참조 문서가 업데이트되면 자동으로 최신 내용 반영
    • 체크 해제: 현재 선택된 특정 버전으로 고정

참조 문서 삭제

참조 문서 탭을 삭제하려면:

  1. 삭제할 탭의 제목 옆에 있는 X 버튼을 클릭합니다.
  2. 확인 대화상자에서 "삭제" 버튼을 클릭합니다.

미리보기 모드 사용

편집 중에 화면이 어떻게 보일지 확인하려면 미리보기 모드를 사용할 수 있습니다:

  1. 편집 화면 우측 상단의 눈 아이콘을 클릭하여 미리보기 모드로 전환합니다.
  2. 연필 아이콘을 클릭하여 다시 편집 모드로 돌아갑니다.

화면 최대화/최소화

편집이나 미리보기를 위한 공간을 확보하려면 화면을 최대화할 수 있습니다:

  1. 우측 상단의 최대화 아이콘을 클릭하여 화면을 확장합니다.
  2. 최소화 아이콘을 클릭하여 원래 크기로 돌아갑니다.

변경 사항 저장

편집이 완료되면 우측 상단의 저장 버튼을 클릭하여 변경 사항을 저장합니다:

저장 시 상태를 선택할 수 있습니다:

  • 임시 저장: 작업 중인 상태로 저장
  • 검토 요청: 검토가 필요한 상태로 변경
  • 승인: 검토 완료 후 승인된 상태로 변경
  • 거부: 검토 후 수정이 필요한 상태로 변경
  • 완료: 모든 과정이 완료된 상태로 변경

작업 취소

편집 중 작업을 취소하려면 "취소" 버튼을 클릭합니다. 저장하지 않은 변경 사항은 모두 손실됩니다.

새 버전 작성하기

문서의 새 버전을 생성하려면:

  1. 문서 상세 보기 화면에서 우측 상단의 "..." 메뉴를 클릭합니다.
  2. "새 버전 추가" 옵션을 선택합니다.
  3. 변경 사유와 새 버전의 내용을 입력합니다.
  4. 변경 사항을 저장합니다.

편집 팁

참조 문서 내용 활용

참조 문서의 내용은 직접 편집할 수 없지만, 시작하기 탭에서 다음과 같은 방식으로 활용할 수 있습니다:

  • 참조 문서의 특정 부분에 대한 사용자 친화적인 설명 추가
  • 탭 간 이동을 위한 내부 링크 추가 (예: "자세한 내용은 '고객 관리' 탭을 참조하세요.")
  • 여러 참조 문서의 기능을 결합한 작업 흐름 설명
  • 사용자 관점에서의 추가 사용법이나 팁 제공

일관성 유지

문서의 일관성을 유지하기 위해 다음 사항에 주의하세요:

  • 용어와 표현을 일관되게 사용
  • 유사한 작업이나 절차는 동일한 형식으로 설명
  • 제목 레벨의 계층 구조를 일관되게 유지
  • 화면 경로나 버튼명 등은 정확하게 인용(따옴표나 굵게 처리)

사용성 향상

  • 목차나 색인을 추가하여 문서 내 탐색을 용이하게 함
  • 중요한 정보는 박스나 배경색으로 강조
  • 주의사항이나 팁은 별도 섹션으로 분리
  • 단계별 절차는 일관된 형식으로 번호 매기기

Intellidesk