들어가며

어떻게 하면 소프트웨어 매뉴얼과 같은 긴 문서를 효율적으로 작성할 수 있을까?

한 명이 매뉴얼을 작성하고 결과물을 PDF 파일로만 제공한다면 익숙한 워드 프로세서를 사용하면 됩니다. 하지만 여럿이 매뉴얼을 작성하고 PDF 파일뿐 아니라 웹으로도 결과물을 제공해야 한다면 여러 문제에 부딪힙니다.

첫째, 매뉴얼 내용을 쓰고 다듬는 일 외의 작업에 시간과 자원을 낭비하게 됩니다.

• 여럿이 매뉴얼을 작성하는 과정에서 파일을 분리하고 취합하는 데 많은 시간을 씁니다.

• 여럿이 작성한 매뉴얼의 서식을 통일하는 데 많은 시간을 씁니다.

• PDF 파일을 제공하면서 웹과 모바일도 함께 지원하기 어렵습니다. 워드 프로세서로는 웹과 모바일에 대응하기 어렵고, 위키로는 전체 매뉴얼을 구조화하거나 하나의 완성된 PDF 파일을 만들기 어렵습니다.

둘째, 한 번 작성한 매뉴얼을 관리하기가 쉽지 않습니다.

• 내용이 바뀔 때마다 드는 시간과 비용을 감당하기 어려워 내용을 바로 바꾸지 못할 때가 많습니다.

• 이력이 관리되지 않아 누가 언제 무엇을 바꿨는지 확인할 수 없습니다. 번역한 뒤 추가 번역이 필요한 부분을 추리기도 어렵습니다.

쓰리래빗츠 북을 사용하면 이런 문제를 줄일 수 있습니다. 도움말, 매뉴얼, 문서 작성 소프트웨어인 쓰리래빗츠 북은 작성자가 매뉴얼 내용 작성에 집중하도록 돕고, 한 번 작성한 매뉴얼을 계속 활용할 수 있게 합니다.

쓰리래빗츠 북의 특징

쓰리래빗츠 북의 주요 특징은 다음과 같습니다.

다양한 운영체제 지원

쓰리래빗츠 북은 웹 애플리케이션입니다. 내용 작성부터 파일 만들기와 공유까지 웹 브라우저에서 작업합니다. 인터넷이 되면 언제 어디서나 여럿이 함께 작업할 수 있습니다.

프레임메이커¹와 같은 대부분의 매뉴얼 저작 도구는 리눅스와 맥에서 사용할 수 없고 윈도우에서만 사용할 수 있습니다. 쓰리래빗츠 북은 웹 브라우저에서 동작하므로 다양한 운영체제에서 사용할 수 있습니다.

공동 작업

매뉴얼 공동 작업은 전체 매뉴얼을 담당자별로 나누어 작성하고, 교정한 뒤 다시 취합하는 과정을 반복하는 일입니다. 쓰리래빗츠 북은 이 과정을 편하게 처리할 수 있게 돕습니다.

전체를 부와 장으로 나누기

혼자가 아니라 여럿이 워드 프로세서로 매뉴얼을 작성하면 불편합니다. 공동 작업을 위해 파일을 나누어 작성하고, 파일 서버나 메일로 다시 취합하는 과정을 반복해야 합니다. 이 과정에서 내용이 빠지기 쉽고 어긋난 서식을 맞추는 일에도 신경 써야 합니다.

DocBook과 같이 쓰리래빗츠 북은 매뉴얼을 여러 부와 장으로 나누고 장 단위로 내용을 작성하게 합니다. 워드 프로세서와 달리 수작업으로 파일을 나누고 합칠 필요가 없습니다.

예를 들어 다음과 같이 차례를 구성할 수 있습니다.

단락 단위 편집

워드 프로세서에서는 전체 문서를 자유롭게 편집할 수 있지만, 쓰리래빗츠 북 에디터에서는 단락 단위로 내용을 편집합니다. 단락 단위 편집의 장점은 다음과 같습니다.

• 여럿이 동시에 같은 장을 편집할 수 있습니다.

• 구조적 글쓰기가 가능합니다.

• 정교한 이력 관리가 가능합니다.

• 내용과 서식을 분리할 수 있습니다.

단일 원천 출판

매뉴얼웍스로 한 번 내용을 작성하면 웹 문서를 만들어 웹 매뉴얼이나 도움말 페이지로 사용할 수 있습니다. 추가 편집 작업 없이 다양한 고객 요구와 사용 목적(웹, 인쇄, 스마트폰)에 맞는 형식(PDF, EPUB 등)의 파일도 만들 수 있습니다.

웹으로 내보내기

다른 매뉴얼 작성 도구도 HTML 파일 내보내기를 지원하지만, 다음과 같은 문제점이 있습니다.

• 기본으로 제공하는 HTML 모습에 한계가 있습니다. 서식 변경이 가능하지 않거나 복잡한 과정을 거쳐야 합니다. HTML이 아닌 XML로 내보낸 후 다른 도구나 개발을 통해 적합한 HTML을 만드는 추가 투자가 필요할 수 있습니다.

• 차례를 내비게이션으로 제공할 때 프레임(frame)으로 HTML을 만들기 때문에 구글과 같은 검색 엔진이 검색하지 못할 수 있습니다.

• 수정이 일어날 때마다 FTP로 웹 서버에 HTML 파일을 올리는 작업을 반복해야 합니다. 이를 위해 내용 작성 도구와는 별도로 서버 군 제품을 구매해야 할 수도 있습니다.

쓰리래빗츠 북은 웹에서 동작하므로 작성과 함께 웹으로 공개되고 수정 사항이 바로 반영됩니다. 웹 뷰어 서식도 다양하게 꾸밀 수 있고, 구글과 같은 검색 엔진이 검색할 수 있도록 설계했습니다.

웹 뷰어 주요 구성 요소는 다음과 같습니다.

PDF 내보내기

많은 위키 제품은 PDF 내보내기를 지원하지 않거나 하나의 완성된 PDF 파일을 만들지 못합니다. 매뉴얼웍스는 높은 품질의 PDF 파일을 만들 수 있습니다.

다음은 쓰리래빗츠 북으로 만든 PDF 파일 스크린 샷입니다.

EPUB 내보내기

쓰리래빗츠 북은 스마트폰이나 태블릿에서 읽을 수 있는 EPUB 파일 내보내기를 지원합니다.

다음은 아이패드에서 쓰리래빗츠 북으로 만든 EPUB 파일을 열었을 때의 스크린 샷입니다.

내용과 서식의 분리

좋은 매뉴얼은 서식 통일성을 유지해야 합니다. 워드 프로세서를 사용하면 서식을 통일하기 위해 많은 노력을 해야 합니다. 누가 작성했느냐에 따라서 또는 언제 작성했느냐에 따라서 서식에 차이가 생깁니다. 한 명이 책임을 지고 주기적으로 서식 통일 작업을 하지 않으면 시간이 흐르면 흐를수록 정도가 심해지고, 취합 과정에서 번호 매기기가 어긋나기도 합니다.

반면 쓰리래빗츠 북은 내용과 서식을 완전하게 분리합니다. 내용을 작성하는 과정에서 서식 정보를 넣을 수 없습니다. 단락에 들여쓰기나 단락 사이 간격을 설정하는 대신에 유형을 선택하여 의미를 부여한 후 테마로 일괄적으로 서식을 설정합니다. 이를 단락 유형이라고 합니다.

특정 문자열에 글꼴 색상이나 굵게를 직접 설정하는 대신 의미를 부여한 후 테마로 일괄 적용합니다. 이를 문자 유형이라고 합니다.

웹 뷰어로 보거나 PDF 파일을 만들 때 어떤 테마와 레이아웃을 사용할지 선택하면 앞에서 설정한 단락 유형과 문자 유형에 맞춰 최종 결과물을 만듭니다.

이력 관리

모든 편집 이력을 저장하며, 이력 비교와 삭제된 단락 복원 기능으로 협업 중에도 안전하게 문서를 보관할 수 있습니다.

비주얼 에디터로 그림에 콜아웃 달기

소프트웨어 매뉴얼을 작성하다 보면 스크린 샷에 콜아웃을 넣어야 할 때가 있습니다. 비주얼 에디터로 간단하게 처리할 수 있습니다.

비주얼 에디터와 함께 “콜아웃 목록” 단락 유형과 “콜아웃” 문자 유형으로 다음과 같은 내용을 작성할 수 있습니다.

자동화와 재사용

다양한 항목에 대한 자동화를 지원합니다.

• PDF 표제지와 정 첫 페이지 등을 자동으로 만들어줍니다.

• 제목, 표, 그림 차례를 자동으로 만들어줍니다.

• 찾아보기(색인)를 자동으로 만들어줍니다.

비슷한 여러 매뉴얼을 작성하면 같은 내용이 여기저기에 반복됩니다. 이를 효과적으로 재사용할 수 있는 기능을 제공합니다.

• 장 단위로 내용을 재사용할 수 있습니다.

• 절이나 단락 단위로 내용을 재사용할 수 있습니다.

• 이미지 단락을 참조할 수 있습니다.

• 테마와 레이아웃을 여러 매뉴얼에서 사용할 수 있습니다.

쉬운 설치와 업데이트

윈도우, 리눅스, 유닉스, 맥 등 다양한 운영체제에서 설치 파일 압축을 풀고 설치 마법사로 옵션을 설정하면 매뉴얼웍스를 설치할 수 있습니다.

새 릴리스를 확인한 후 몇 번의 클릭과 서버 재시작만으로 쓰리래빗츠 북을 업데이트할 수 있습니다.

마치며

제품을 출시하고 서비스를 개선할 때마다 반복되는 매뉴얼 작성의 비효율을 줄이려는 분들께 쓰리래빗츠 북이 해법이 되기를 바랍니다.

궁금한 사항은 다음 이메일(support@3rabbitz.com) 주소로 보내주세요.

1. 어도비에서 만든 책 또는 매뉴얼 작성 소프트웨어입니다. 자세한 내용은 http://www.adobe.com/products/framemaker.html을 참고합니다.