들어가며
매뉴얼을 작성하면서 마주치는 문제는 다음과 같습니다.
- 공동으로 매뉴얼을 작성하는 과정에서 파일 관리에 어려움을 겪게 됩니다.
공동 작업을 위해 여럿이 파일을 분리하여 작성하고, 파일 서버나 메일로 다시 취합하는 번거로운 과정을 반복해야 합니다.
- 여럿이 작업한 매뉴얼의 서식을 통일하기 위해 많은 시간을 허비하게 됩니다.
서식을 적용하고 변경하는 시간이 내용을 작성하는 시간보다 많이 소요됩니다.
- PDF 파일을 제공하면서 웹과 모바일도 함께 지원하기 어렵습니다.
워드 프로세서를 사용하면 PDF 파일은 만들 수 있지만 웹과 모바일에 대응하기 어렵습니다. 반면 위키는 웹에는 적합하지만 전체 매뉴얼을 구조화하기 어렵고 하나의 완성된 PDF 파일을 얻기 어렵습니다.
- 매뉴얼 내용이 갱신될 때마다 이를 결과물에 반영하는데 어려움을 겪게 됩니다.
내용이 바뀔 때마다 지속적으로 소모되는 시간과 비용을 감당할 수 없어 내용을 바로 변경하지 못할 때가 많습니다.
쓰리래빗츠 북을 사용하면 이런 문제점을 극복하고 빠르게 매뉴얼을 작성할 수 있습니다. 도움말, 매뉴얼, 문서 작성 소프트웨어인 쓰리래빗츠 북의 특징은 다음과 같습니다.
- 웹 애플리케이션
내용 작성부터 파일 빌드와 공유까지 웹 브라우저에서 모든 작업을 수행하기 때문에 인터넷이 되면 언제 어디서나 여럿이 함께 작업할 수 있습니다.
- 단일 원천 출판 지원
하나의 내용을 작성하면 그 내용으로 웹 문서를 생성하여 웹 매뉴얼이나 도움말 페이지로 사용할 수 있습니다. 또한 추가적인 편집 작업 없이 다양한 고객 요구와 사용 목적(웹, 인쇄, 스마트폰)에 적합한 다양한 형식(PDF, EPUB 등)의 파일을 만들 수 있습니다.
- 단락 단위 편집
단락 단위 편집으로 서식에는 신경쓰지 않고 전달하고자 하는 내용이 정확하고 상세하도록 내용을 작성하는데 시간과 노력을 할애할 수 있습니다.
- 자동화와 재사용
표제지, 차례, 찾아보기 등 문서의 주요 구성 요소를 자동으로 만들어주고, 다른 문서에서 장, 절, 단락을 재사용할 수 있습니다.
이 글에서는 쓰리래빗츠 북으로 매뉴얼을 작성하는 방법을 간략하게 살펴보겠습니다.
매뉴얼 차례 구성하기
쓰리래빗츠 북은 DocBook과 같이 여러 장으로 이루어진 책을 만드는 방식으로 동작합니다. 매뉴얼을 작성하는 기본 과정은 다음과 같습니다.
<다른 단락 포함하기>로 DITA와 같이 장이 아닌 절, 단락 단위로 내용을 작성할 수 있습니다.
대시보드에서 <책 만들기> 링크를 클릭하여 책을 만듭니다.
책 상세 화면에서 <장 만들기> 링크를 클릭하여 필요한 장을 추가합니다.
장을 만들 때 장 유형으로 무엇을 선택하느냐에 따라 모습과 기능이 달라집니다. 다음은 주요 장 유형에 대한 설명입니다.
부분 | 장 유형 | 비고 |
|---|---|---|
권두 부분 | 제목 | 텍스트 단락 중심의 다른 장과 달리 제목 장은 고유한 기능을 하는 약표제지, 표제지, 저작권, 헌사 등의 페이지들로 구성됩니다. |
추천사 | ||
차례 | ||
그림 차례 | ||
표 차례 | ||
머리말 | ||
감사의 글 | ||
권두 장 | ||
본문 | 장 | 내용을 작성하는 기본 단위입니다. |
부 | 여러 장을 묶을 때 사용합니다. | |
권말 부분 | 부록 | |
찾아보기 | ||
권말 장 |
예를 들어 다음과 같이 차례를 구성할 수 있습니다.
매뉴얼 내용 작성하기
쓰리래빗츠 북 에디터(이하 에디터)는 기존 워드 프로세서와는 다른 방식으로 동작합니다. 워드 프로세서에서는 전체 문서를 자유롭게 편집할 수 있지만 에디터에서는 단락 단위로 편집합니다. 이런 단락 단위 편집이 주는 장점은 다음과 같습니다.
구조적 글쓰기가 가능합니다.
정교한 이력 관리가 가능합니다.
여럿이 동시에 동일한 문서를 편집할 수 있습니다.
내용과 서식을 분리할 수 있습니다.
에디터
단락 단위 편집 방식에서 마우스에만 의존해서 글을 쓰면 불편합니다. 그래서 마우스 사용을 최소화하고 키보드만으로 빠르게 글을 쓰게 해주는 단축키를 제공합니다.
단락 편집
단락 추가
도구 모음()을 클릭하거나 끌어다 넣기(드래그 앤 드랍)해서 텍스트, 그림, 표, 객체 단락을 원하는 위치에 추가할 수 있습니다.
<Ctrl + I>와 <Ctrl + Alt + I> 단축키1로도 단락을 추가할 수 있습니다.
단락을 추가할 때 다음을 참고합니다.
빈 문서에는 클릭 또는 단축키로만 단락을 추가할 수 있습니다. 끌어다 넣기로는 추가할 수 없습니다.
클릭 또는 단축키로 추가할 때 선택된 단락이 있으면 선택된 단락 아래에 추가됩니다.
클릭 또는 단축키로 추가할 때 선택된 단락이 없으면 맨 마지막에 추가됩니다.
끌어다 넣는 중간에 <
Esc> 키를 누르면 끌어다 넣기가 취소됩니다.
텍스트 단락을 추가할 때 단락 세부 유형을 선택합니다.
유형 | 세부 유형 |
|---|---|
텍스트 | 보통 제목 1~5 헤드라인 코드 명령어 줄바꿈 유지 블럭 인용구 권두 명구 순서 목록 비순서 목록 정의 목록 콜아웃 목록 노트 팁 주의 교정 |
그림 | 내 컴퓨터에서 가져오기 다른 책에서 가져오기 웹에서 가져오기 웹에서 기타 요소 가져오기 |
표 | |
객체 | 차례 그림 차례 표 차례 찾아보기 자동 페이지 나누기 빈 페이지 여백 수평선 Float 하지 않기 레이아웃 페이지 디자인 페이지 다른 단락 포함하기 |
단락 유형 설정
단락 선택
에디터에서 이루어지는 작업의 대부분이 단락을 선택한 후에 이루어집니다. 그래서 단락을 선택하는 다양한 방법을 제공합니다.
마우스 클릭으로 단락을 선택할 수 있습니다. 마우스 클릭과 함께 <
Shift> 키를 눌러 여러 단락을 선택할 수 있습니다.<
Up(↑)>과 <Down(↓)> 키로 단락을 선택하고 선택된 단락을 변경할 수 있습니다. <Shift> 키를 함께 눌러 여러 단락을 선택할 수 있습니다.<
Home>, <End>, <Page Up>, <Page Down> 키로 선택된 단락을 변경할 수 있습니다.<
Ctrl + A> 단축키로 모든 단락을 선택할 수 있습니다.<
Esc> 키를 누르면 단락 선택이 취소됩니다.
단락 편집
새로운 단락은 편집 모드로 삽입되고, 기존 단락은 선택된 단락 오른쪽 아래에 있는 <편집> 링크를 클릭하거나, 단락을 더블 클릭하거나, <Enter> 키를 누르면 편집 모드로 변경됩니다.
편집 모드에서 오른쪽 아래에 있는 <저장> 버튼을 클릭하거나, <
Ctrl + S> 단축키를 누르면 내용이 저장됩니다.편집 모드에서 오른쪽 아래에 있는 <취소> 링크를 클릭하거나, <
Esc> 키를 누르면 저장 없이 일반 모드로 전환됩니다.
편집 모드에서는 다른 단락을 편집할 수 없습니다.
문자 유형 설정
워드 프로세서와 달리 특정 문자열에 대해서 글꼴 색상을 설정하거나 굵게 쓰도록 설정할 수 없습니다. 대신 특정 문자열에 의미를 부여한 후 테마를 통해 일괄적으로 서식을 설정할 수 있습니다. 이를 문자 유형이라고 합니다.
주요 문자 유형은 다음과 같습니다.
매우 강조
강조
코드
인라인 주석
아래 첨자
위 첨자
삭제
교정(교정을 위한 문자 유형으로 에디터에서만 보이고 웹 뷰어, PDF, EPUB 등에서는 보이지 않습니다.)
콜아웃
문자 유형 설정
다음 순서로 문자 유형을 설정합니다.
문자 유형을 설정할 문자열을 선택합니다.
마우스 끌기나
<Shift + Left>와<Shift + Right>단축키로 문자열을 선택할 수 있습니다.
텍스트 에디터 왼쪽 위에 있는 문자 유형을 선택합니다.
<
Ctrl + Space> 단축키로 설정할 수도 있습니다.
다음과 같은 방법으로 문자 유형을 삭제합니다.
문자 유형을 삭제할 문자열을 더블 클릭하여 삭제합니다.
문자 유형을 삭제할 문자열에 커서를 위치시킨 후 <
Ctrl + Space> 단축키로 삭제합니다.
비주얼 에디터로 그림 편집하기
그림에 선, 도형, 콜아웃, 문자 등을 넣어야 할 때까 있습니다. 비주얼 에디터로 이런 작업을 할 수 있습니다.
그림 단락 오른쪽 위에 있는 <비주얼 에디터> 버튼을 클릭합니다.
그림에 텍스트 상자, 도형 등을 넣습니다.
<저장> 버튼을 클릭합니다.
여기서는 설명하지 않은 다양한 편집 기능(이력, 링크, 찾아보기, 주석, 단락내 그림, 특수 문자, 찾기와 바꾸기)을 제공합니다.
매뉴얼 내보내기
작성한 매뉴얼을 웹 뷰어로 웹에 공개할 수 있고, PDF와 EPUB 파일로 내려받을 수 있습니다.
테마와 레이아웃으로 이루어져있는 서식 메뉴에서 웹 뷰어, PDF, EPUB 파일 서식을 다양하게 꾸밀 수 있습니다.
웹 뷰어
웹 뷰어란 작성한 책을 웹에서 바로 볼 수 있도록 해주는 기능입니다. 어떤 웹 테마와 웹 뷰어 레이아웃을 선택하느냐에 따라 모습이 달라집니다.
내용이 변경되면 파일을 다시 만들어야 하는 PDF와 EPUB와는 달리 웹 뷰어에는 변경 내용이 실시간으로 반영됩니다.
웹 뷰어
웹 뷰어 주요 구성 요소는 다음과 같습니다.
1제목, 그림, 표 차례를 보여줍니다.
2검색 기능을 제공합니다.
3찾아보기를 보여줍니다. 단, 찾아보기 유형 장이 있을 때만 나타납니다.
4<PDF와 EPUB 내려받기> 링크를 제공합니다.
PDF 파일
책을 PDF 파일로 내보낼 수 있습니다. 어떤 PDF 테마와 PDF 페이지 레이아웃을 선택하느냐에 따라서 모양이 달라집니다.
PDF 내보내기
웹 뷰어와는 달리 내용이 변경되면 PDF 파일을 다시 만들어야 합니다.
다음 순서로 PDF 파일을 만듭니다.
<PDF 내려받기> 링크를 클릭합니다.
<PDF 내려받기> 오버레이에서 PDF 테마와 PDF 페이지 레이아웃을 선택한 후 <시작> 버튼을 클릭합니다.
책 내용 분량과 포함된 그림 수에 따라 PDF 만들기에 걸리는 시간이 달라집니다.
새로 만들지 않고 마지막에 만든 PDF 파일을 내려받으려면 하단에 있는 <마지막으로 만든 PDF 파일 내려받기> 링크를 클릭합니다.
다음은 쓰리래빗츠 북으로 만든 PDF 파일 스크린 샷입니다.
EPUB 파일
책을 EPUB 파일로 내보낼 수 있습니다. 어떤 EPUB 테마를 선택하느냐에 따라서 모양이 달라집니다.
웹 뷰어나 PDF와 달리 레이아웃을 선택하지 않습니다. iBooks와 같은 EPUB 리더가 레이아웃의 역할을 하기 때문입니다.
EPUB 내보내기
웹 뷰어와는 달리 내용이 변경되면 EPUB 파일을 다시 만들어야 합니다.
다음 순서로 EPUB 파일을 만듭니다.
<EPUB 내려받기> 링크를 클릭합니다.
<EPUB 내려받기> 오버레이에서 EPUB 테마와 표지 그림을 선택한 후 <시작> 버튼을 클릭합니다.
책 내용 분량과 포함된 그림 수에 따라 EPUB 만들기에 걸리는 시간이 달라집니다.
새로 만들지 않고 마지막에 만든 EPUB 파일을 내려받으려면 하단에 있는 <마지막으로 만든 EPUB 파일 내려받기> 링크를 클릭합니다.
다음은 쓰리래빗츠 북으로 만든 EPUB 파일 스크린 샷입니다.
매뉴얼 내용 수정하기
매뉴얼 작성을 완료한 후에도 잦은 내용 수정이 이루어집니다. 쓰리래빗츠 북을 사용하면 PDF와 EPUB 파일을 다시 만들기만 하면 에디터에서 수정한 사항이 바로 반영됩니다.
앞에서 설명한 대로 PDF와 EPUB 파일을 만들어도 되고, 다음과 같이 여러 문서에 대해서 한번에 만들수도 있습니다.
대시보드에서 <파일 내보내기> 링크를 클릭합니다.
왼쪽에서 PDF와 EPUB 파일을 만들 문서를 선택합니다.
<시작> 버튼을 클릭하여 파일 만들기를 합니다.
마치며
날이 갈수록 경쟁이 치열해지면서 제품이나 서비스 개발에 많은 시간과 노력을 할애해도 언제나 부족하게 느끼기 마련입니다. 매뉴얼과 문서의 중요성과 필요성을 알면서도 우선 순위에서 항상 밀리고 막바지에 서둘러 작업한 결과물은 기대치를 밑돌기 마련입니다.
앞에서 설명한대로 쓰리래빗츠 북을 사용하여 매뉴얼을 더 빠르게 작성하고, 적은 비용으로 관리할 수 있게 되기를 희망합니다.
궁금한 사항은 다음 이메일(support@3rabbitz.com) 주소로 보내주세요.
쓰리래빗츠 북은 자바로 개발한 서버 애플리케이션으로, 설치 후에 웹 브라우저로 접속하여 사용하는 웹 기반 소프트웨어입니다. 오픈소스 프로젝트와 비영리 단체에는 내부 심사를 거친 후 무상 라이선스를 제공합니다. 홈페이지(http://www.3rabbitz.com)에서 회원가입 후 제품을 체험해 볼 수 있으며, 1개월 무료 평가판을 다운로드하여 보유한 서버에 설치해 사용할 수도 있습니다. 자세한 설명은 설치 가이드와 사용자 가이드를 참고하세요.
- 여기서는 윈도우를 기준으로 단축키를 설명합니다. 리눅스와 맥 OS에서는 일부 단축키가 다를 수 있습니다.