ezinc 가이드 문서
Search posts...
  • Home

Categories

  • All Posts13
  • 클립리포트5
  • Ezworks3
  • Git2
  • 문서 작성 가이드3
General•2026년 5월 8일

쓰리래빗츠 북 매뉴얼 작성 가이드

이 문서는 통합학사정보시스템 매뉴얼을 유지보수하는 작성자를 위한 쓰리래빗츠 북 사용 가이드입니다. 메뉴가 추가되거나 화면이 변경되었을 때 문서 찾기, 장 추가, 내용 작성, 이미지 등록, 공개 전 확인까지 진행하는 데 필요한 기능을 정리했습니다.

IMPORTANT

관리자 설정, 테마 제작, 서버 운영, 사용자 권한 세부 설정은 이 문서의 범위에서 제외합니다. 일반 작성자는 기존 프로젝트와 문서 구조를 유지하면서 장과 단락을 추가하고, 공개 전 결과를 확인하는 작업에 집중하면 됩니다.

빠른 진행 순서

단계 작업 확인 포인트
1 문서 찾기 문서 탐색기에서 통합학사정보시스템 문서를 엽니다.
2 장 추가 기존 차례 위치에 맞게 장을 만들거나 여러 장을 한번에 만듭니다.
3 단락 작성 텍스트, 그림, 표, 객체 단락을 목적에 맞게 추가합니다.
4 화면 이미지 등록 화면 캡처 이미지를 그림 단락으로 올리고 필요한 경우 비주얼 에디터로 표시합니다.
5 공개 전 검토 미리 보기, 태그, PDF/HTML 파일 생성 결과를 확인합니다.

1. 접속과 문서 찾기

쓰리래빗츠 북에 로그인한 뒤 오른쪽 위의 BOOK 메뉴로 이동합니다. 대시보드 또는 문서 탐색기에서 작성할 문서를 찾습니다.

문서 탐색기는 왼쪽에 트리 형태로 프로젝트와 문서를 보여줍니다. 문서 제목을 클릭하면 문서 상세 화면으로 이동하고, 장 또는 절 제목을 클릭하면 에디터가 열립니다.[1]

NOTE

장을 클릭했을 때 에디터가 아니라 웹 뷰어가 열리면 편집 권한이 없을 수 있습니다. 이 경우 관리자 또는 프로젝트 담당자에게 권한 확인을 요청하세요.


2. 문서와 장 구조 이해

쓰리래빗츠 북은 문서를 한 번에 긴 글로 작성하지 않고, 문서 > 장 > 단락 구조로 작성합니다. 통합학사정보시스템 매뉴얼처럼 메뉴별 설명이 많은 문서는 이 구조를 유지해야 나중에 차례, 검색, PDF 생성 결과가 안정적으로 나옵니다.

구조 작성 기준
문서 통합학사정보시스템 같은 전체 매뉴얼 단위
부(Part) 일반, 입학, 학사, 등록처럼 큰 업무 영역
장(Chapter) 특정 메뉴 또는 기능 묶음
절(Section) 화면 구성, 조회, 저장, 출력처럼 장 안의 세부 흐름
단락(Paragraph) 설명 문장, 화면 이미지, 표, 코드, 주의 문구 등 실제 내용

TIP

메뉴가 추가될 때는 먼저 기존 통합학사정보시스템 PDF의 차례에서 비슷한 업무 영역을 확인한 뒤, 같은 깊이와 이름 규칙으로 장을 추가하는 것이 좋습니다.


3. 장 추가와 차례 관리

문서 상세 화면의 차례 영역에서 장을 만듭니다. 새 메뉴 하나만 추가할 때는 장 만들기, 여러 메뉴를 한 번에 등록할 때는 여러 장 만들기를 사용합니다.[2]

장 만들기 화면에서는 다음 항목을 확인합니다.

항목 작성 기준
제목 실제 메뉴명 또는 사용자가 보는 기능명으로 입력
유형 일반 메뉴 설명은 보통 본문 유형을 사용
위치 기존 업무 영역 아래에 배치
감추기 옵션 PDF나 웹 뷰어에서 제외해야 하는 임시 장일 때만 선택

WARNING

장 제목의 단계가 어긋나면 차례가 이상하게 보일 수 있습니다. 예를 들어 제목 1 다음에 바로 제목 3이 오지 않도록 중간 수준을 맞추세요.


4. 에디터 기본 작업

에디터는 워드처럼 한 페이지를 통째로 편집하는 방식이 아니라 단락 단위로 편집합니다. 단락을 선택하고 추가, 편집, 이동, 복사, 삭제를 반복하면서 내용을 구성합니다.

4.1. 단락 추가

자주 쓰는 단락은 다음 네 가지입니다.

단락 용도 단축키
텍스트 설명, 제목, 목록, 노트, 주의 문구 Ctrl + 1
그림 화면 캡처, 업무 흐름 이미지 Ctrl + 2
표 버튼 목록, 입력 항목, 처리 결과 Ctrl + 3
객체 차례, 페이지 나누기, 여백, 수평선 등 Ctrl + 4

선택한 단락이 있으면 새 단락은 선택한 단락 아래에 추가됩니다. Alt를 함께 누르면 선택한 단락 위에 추가할 수 있습니다.

4.2. 단락 편집과 저장

단락 오른쪽 아래의 편집 아이콘을 누르거나, 단락을 더블 클릭하거나, 선택 후 Enter를 누르면 편집 모드로 바뀝니다. 저장은 저장 버튼 또는 Ctrl + S를 사용합니다.

CAUTION

편집 모드에서 저장하지 않고 다른 화면으로 이동하면 입력한 내용이 사라질 수 있습니다. 긴 내용을 작성할 때는 중간중간 Ctrl + S로 저장하세요.

4.3. 단락 옵션

단락 옵션에서는 내보내기 형식별 감추기, 그림 Float, 표 레이아웃, 코드 언어, 사용자 정의 아이디 등을 설정합니다.

작성자가 자주 쓰는 옵션은 다음 정도입니다.

옵션 사용할 때
단락 감추기 PDF 또는 웹 뷰어에 임시 설명을 보이지 않게 할 때
그림 Float 그림 옆에 짧은 설명 문장을 배치할 때
표 레이아웃 표 열 너비를 자동/고정/직접 설정으로 맞출 때
언어 코드 또는 SQL 예시에 하이라이트를 적용할 때

5. 텍스트 작성 기준

텍스트 단락은 단락 유형을 선택해서 작성합니다. 기능 설명 매뉴얼에서는 보통, 제목, 순서 목록, 비순서 목록, 노트, 팁, 주의, 코드 유형을 주로 사용합니다.

유형 사용 예
보통 화면의 목적, 사용 조건, 처리 결과 설명
제목 1~5 장 안에서 절과 세부 절을 나눌 때
순서 목록 사용자가 따라 해야 하는 절차
비순서 목록 버튼, 조건, 참고 사항 나열
노트/팁/주의 꼭 봐야 할 안내와 경고
코드/명령어 SQL, 명령어, 설정값 예시

코드 단락은 옵션에서 언어와 줄 번호를 설정할 수 있습니다.

TIP

화면 조작 절차는 순서 목록으로 쓰고, 입력 항목 설명은 표로 쓰면 나중에 변경 내용을 찾기 쉽습니다.


6. 화면 이미지 등록

메뉴얼 유지보수에서 가장 자주 하는 작업은 화면 캡처를 교체하거나 새로 등록하는 일입니다. 화면 캡처 파일은 먼저 로컬 PC에 저장한 뒤 그림 단락으로 업로드합니다.

그림 파일은 다음 기준으로 준비합니다.

기준 권장 내용
파일 형식 PNG 우선, 필요 시 JPEG 사용
캡처 범위 메뉴명, 검색 조건, 주요 버튼, 결과 영역이 보이게 캡처
파일명 메뉴ID 또는 화면명을 포함해 나중에 찾기 쉽게 작성
개인정보 실명, 학번, 연락처 등 민감 정보가 보이면 가림 처리

다른 문서에 이미 등록된 그림을 재사용해야 할 때는 다른 문서에서 가져오기를 사용할 수 있습니다. 원본 그림 단락이 바뀌면 참조한 그림도 함께 바뀌므로 공통 화면에는 유용하지만, 특정 메뉴 설명에는 독립 업로드가 더 안전합니다.

PDF 품질이 중요한 이미지에는 인쇄용 그림을 별도로 올릴 수 있습니다. 보통 화면 캡처 중심의 업무 매뉴얼은 기본 그림만으로 충분하지만, 조직도나 고해상도 도식처럼 인쇄 품질이 중요한 이미지는 인쇄용 그림을 확인하세요.

WARNING

웹에서 복사한 이미지를 그대로 붙여 넣기 전에 사용 권한과 개인정보를 확인하세요. 업무 매뉴얼에는 직접 캡처한 시스템 화면을 사용하는 것이 가장 안전합니다.


7. 표 작성

버튼 설명, 입력 항목, 검색 조건, 처리 결과는 표 단락으로 정리합니다. 표 왼쪽과 위쪽의 버튼으로 행과 열을 추가하고, 셀을 선택한 뒤 옵션 메뉴에서 병합, 삭제, 복사, 붙여넣기 같은 작업을 합니다.

표 열 너비는 단락 옵션의 표 레이아웃에서 설정합니다.

방식 설명
자동 내용에 맞추어 열 너비를 자동 결정
고정 모든 열을 같은 너비로 배치
설정 30%, 200, ?처럼 열 너비를 직접 지정

TIP

매뉴얼의 입력 항목 표는 항목 / 설명 / 필수 여부 / 비고처럼 고정된 열 구성을 반복하면 읽는 사람이 빠르게 비교할 수 있습니다.


8. 이미지 보정과 비주얼 에디터

그림 단락 오른쪽 위의 비주얼 에디터를 열면 이미지 위에 번호, 화살표, 박스, 설명 텍스트를 추가할 수 있습니다.

비주얼 에디터에서는 저장 버튼을 눌러야 변경 사항이 반영됩니다. 객체를 추가한 뒤 위치와 크기를 조정하고, 필요한 경우 잠금 옵션으로 실수로 움직이지 않게 고정합니다.

화면 캡처에서 불필요한 영역이 많으면 자르기 기능으로 필요한 부분만 남길 수 있습니다.

IMPORTANT

번호 표시를 이미지에 직접 넣었다면 본문 설명의 번호와 반드시 맞춰야 합니다. 화면이 변경되어 이미지만 교체할 때 번호 위치도 함께 확인하세요.


9. 공개 전 검토

작성을 마쳤으면 문서 상세 화면에서 태그를 만들어 현재 시점을 남길 수 있습니다. 태그는 초안, 검토본, 완성본처럼 특정 시점의 내용을 보관하는 용도입니다.[3]

외부에 보여줄 문서는 공개 설정을 확인합니다. 공개 유형은 운영 방식에 맞추되, 변경 중인 문서를 바로 노출하지 않으려면 태그로 공개하는 방식이 안정적입니다.

공개 유형 사용 기준
항상 최신 수정 즉시 웹 뷰어에 반영해도 되는 문서
현재 시점 지금 내용을 기준으로 공개본을 고정할 때
태그로 공개 검토 완료 태그 등 특정 버전을 공개할 때

NOTE

웹 뷰어는 최신 내용이 반영될 수 있지만, PDF/HTML 파일은 파일을 새로 만들어야 최신 수정 사항이 반영됩니다.


10. 파일 만들기와 PDF 확인

문서 상세 화면의 파일 만들기 기능에서 PDF, HTML, EPUB, MS Word 같은 산출물을 생성합니다. 배포용 산출물은 보통 PDF와 웹 뷰어 확인을 우선합니다.

PDF 결과를 확인할 때는 다음 항목을 봅니다.

확인 항목 설명
차례 추가한 장과 제목 단계가 올바르게 반영되었는지 확인
이미지 화면 캡처가 너무 작거나 흐리지 않은지 확인
표 열 너비가 깨지거나 페이지 밖으로 나가지 않는지 확인
페이지 넘김 장 사이 빈 페이지, 그림 잘림, 표 분리 상태 확인
감추기 옵션 PDF에서 제외할 장이나 단락이 실제로 빠졌는지 확인

특정 장을 PDF에서 제외해야 할 때는 장 변경 화면의 감추기 옵션에서 PDF를 선택합니다.

특정 단락만 제외해야 할 때는 에디터에서 단락 옵션을 열어 단락 감추기 대상을 선택합니다.

CAUTION

감추기 옵션은 웹 뷰어, PDF, EPUB, HTML 등 형식별로 따로 적용될 수 있습니다. PDF에서만 감추려던 내용이 웹에도 보이지 않는지, 반대로 웹에 보이면 안 되는 내용이 남아 있지 않은지 함께 확인하세요.


11. 부록. 관리자용 운영 안내

이 절은 서버 패치, 업데이트, 장애 발생 시 관리자가 먼저 확인할 항목을 정리한 내용입니다. 설치·운영 세부 절차는 실제 서버 구성에 따라 달라질 수 있으므로, 운영 서버의 설치 경로와 서비스명을 먼저 확인하세요.[4]

IMPORTANT

아래의 3RABBITZ_HOME은 쓰리래빗츠가 설치된 폴더를 의미합니다. 실제 운영 환경에서는 제품 버전, 설치 방식, 윈도우 서비스명, 포트, 데이터베이스 종류가 다를 수 있으므로 운영 문서의 실제 값을 우선합니다.

11.1. 서버 패치 및 업데이트 시 방법 안내

단계 작업 확인 내용
1 작업 공지 사용자에게 작업 시간과 접속 중단 가능성을 안내합니다.
2 접속자 확인 문서 편집 중인 사용자가 있으면 저장 후 종료하도록 안내합니다.
3 백업 확인 데이터 디렉터리, 백업 디렉터리, 외부 DB 백업 상태를 확인합니다.
4 서비스 중지 윈도우 서비스 또는 shutdown 스크립트로 쓰리래빗츠를 종료합니다.
5 패치 적용 제조사 또는 유지보수 담당자가 제공한 패치 절차에 따라 파일을 반영합니다.
6 서비스 시작 윈도우 서비스 또는 startup 스크립트로 쓰리래빗츠를 시작합니다.
7 로그 확인 3RABBITZ_HOME/logs에서 오류 로그가 없는지 확인합니다.
8 기능 확인 로그인, 문서 열기, 장 편집, 이미지 보기, PDF 생성 여부를 확인합니다.

윈도우에서 스크립트로 시작·종료할 때는 다음 위치를 확인합니다.

3RABBITZ_HOME\bin\startup.bat
3RABBITZ_HOME\bin\shutdown.bat

리눅스에서 스크립트로 시작·종료할 때는 다음 명령을 사용합니다.

cd 3RABBITZ_HOME/bin
./startup.sh
./shutdown.sh

윈도우 서비스로 등록된 환경에서는 서비스 관리 화면에서 시작/중지하거나, 관리자 권한 명령 프롬프트에서 서비스 등록 정보를 확인합니다. 설치 가이드 기준 서비스명은 3Rabbitz이지만 실제 운영 환경에서는 다를 수 있습니다.

WARNING

Oracle 또는 MS SQL Server 같은 외부 데이터베이스를 사용하는 경우, 쓰리래빗츠 파일 백업만으로는 복구가 충분하지 않습니다. DB 자체 백업이 정상적으로 수행되었는지 반드시 확인하세요.

11.2. 업데이트 전 백업 확인

항목 확인 기준
데이터 디렉터리 데이터베이스, 글꼴, 이미지, PDF, EPUB 등 운영 데이터가 저장되는 위치
백업 디렉터리 데이터베이스와 이미지를 백업하는 위치
외부 DB Oracle/MS SQL Server 사용 시 DBMS 백업 도구로 별도 백업
설정 파일 3RABBITZ_HOME/tomcat/conf/server.xml 등 DB 연결 및 포트 관련 설정
라이선스 정보 서버 이전 또는 재설치가 필요한 경우 라이선스 키와 서버 아이디 확인

TIP

설치 가이드는 데이터 디렉터리와 백업 디렉터리를 서로 다른 디스크에 두는 것을 권장합니다. 같은 디스크에 두면 디스크 장애 시 원본과 백업이 함께 손상될 수 있습니다.

11.3. 일반적 시스템 장애 유형 및 대응 방안 안내

장애 유형 1차 확인 대응 방안
접속 불가 서버 전원, 네트워크, URL, 포트, 서비스 상태 서비스가 중지되어 있으면 시작하고, 계속 실패하면 로그 확인 후 유지보수 담당자에게 전달
로그인 불가 계정 잠김, 비밀번호, 사용자 권한, 라이선스 상태 관리자 계정으로 사용자 상태를 확인하고 필요 시 비밀번호 초기화
문서/장 편집 불가 편집 권한, 다른 사용자 편집 상태, 브라우저 오류 권한을 확인하고 저장 후 새로고침, 다른 브라우저에서 재현 여부 확인
이미지가 보이지 않음 그림 파일 존재 여부, 데이터 디렉터리 접근 권한, 브라우저 캐시 이미지 단락을 다시 열어 확인하고, 전체 장애면 로그와 디스크 상태 확인
PDF/HTML 생성 실패 파일 생성 옵션, 디스크 용량, 글꼴, 로그 오류 디스크 여유 공간과 로그를 확인하고, 특정 문서만 실패하는지 전체 실패인지 구분
속도 저하 동시 접속자, 큰 이미지, 대용량 PDF 생성, 서버 리소스 사용량이 낮은 시간에 재시도하고, 반복되면 서버 CPU/메모리/디스크 사용량 확인
업데이트 후 오류 서비스 시작 여부, Java 경로, DB 연결, 설정 파일 변경 패치 전 백업과 설정 파일을 비교하고, 오류 로그와 적용 시간을 함께 전달
DB 연결 오류 DB 서버 상태, 계정/비밀번호, JDBC 드라이버, server.xml DB 접속 가능 여부를 먼저 확인하고, 설정 변경 이력이 있으면 복구
디스크 용량 부족 데이터/백업/로그/PDF 생성 폴더 용량 불필요한 임시 파일과 오래된 산출물을 정리하되, 삭제 전 백업 여부 확인

11.4. 유지보수 담당자에게 전달할 정보

장애가 1차 조치로 해결되지 않으면 아래 정보를 모아 전달합니다.

항목 예시
발생 일시 2026-05-08 10:30
접속 URL 운영 서버 접속 주소
사용자 계정 장애를 겪은 사용자 ID
작업 내용 로그인, 문서 열기, 장 편집, PDF 생성 등
오류 화면 캡처 이미지 또는 오류 문구
재현 여부 특정 PC만 발생하는지, 모든 사용자에게 발생하는지
최근 변경 서버 패치, DB 작업, 네트워크 변경, 인증서 변경 등
로그 파일 3RABBITZ_HOME/logs의 장애 시간대 로그

  1. 원본 가이드의 “6. 문서 탐색기”는 프로젝트 트리, 문서 상세 이동, 장 클릭 시 에디터 열기 흐름을 설명합니다. ↩︎

  2. 원본 가이드의 “7.2 차례 구성하기”는 장 만들기, 여러 장 만들기, 장 변경, 차례 순서 변경 기능을 설명합니다. ↩︎

  3. 원본 가이드의 “11. 문서 공개하기”는 태그 생성, 공개 유형, 파일 생성과 공개 저장 흐름을 설명합니다. ↩︎

  4. 쓰리래빗츠 3.0 설치 가이드는 시작/종료 스크립트, 설치 마법사의 데이터·백업 디렉터리, 로그 위치, 윈도우 서비스 등록, 외부 DB 설정 파일 위치를 설명합니다. 단, 현재 운영 제품 버전과 실제 설치 방식은 운영 서버 기준으로 확인해야 합니다. ↩︎

← Back to all posts