프로그램 매뉴얼 양식 - peulogeulaem maenyueol yangsig

관련글

• 제품 소프트웨어 패키징의 형상 관리 - 제품 소프트웨어의 형상 관리 파악, 제품 소프트웨어의 형상 관리 중요성, 제품 소프트웨어의 형상 관리 역할 CODEDRAGON

• 수행 내용 - 제품 소프트웨어 배포용 미디어 제작하기 CODEDRAGON

• 제품 소프트웨어 설치 매뉴얼의 개요 - 제품 소프트웨어의 매뉴얼의 파악, 설치 매뉴얼 작성의 기본 사항 CODEDRAGON

• 수행 내용 - 패키징 도구를 활용한 설치, 배포 수행하기 CODEDRAGON

댓글 0

+ 이전 댓글 더보기

비공개 댓글 남기기

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

첫째, 매뉴얼 내용을 쓰고 가다듬는 일이 아닌 다른 작업에 소중한 시간과 자원을 낭비하게 됩니다.

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

• 여럿이 작성한 매뉴얼의 서식을 통일서식 통일하기 위해 많은 시간을 허비하게 됩니다.

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

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

• 내용이 바뀔 때마다 소모되는 시간과 비용을 감당할 수 없어 내용을 바로 변경하지 못할 때가 많습니다.

• 이력이 관리되지 않아 누가 언제 무엇을 변경했는지 확인할 수 없고, 번역했을 때 추가로 번역이 필요한 부분을 간추리기가 어렵습니다.

쓰리래빗츠 북을 사용하면 이런 문제점을 극복할 수 있습니다. 도움말, 매뉴얼, 문서 작성 소프트웨어인 쓰리래빗츠 북은 작성자에게 매뉴얼 내용 작성에만 집중할 수 있는 환경을 제공하고, 한 번 작성한 매뉴얼이 생명력을 가지면서 활용될 수 있도록 도와줍니다.

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

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

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

매뉴얼 공동 작업은 전체 매뉴얼을 담당자별로 나누어 작성하고, 교정 작업을 거쳐 다시 취합하는 과정의 반복입니다. 쓰리래빗츠 북은 편리한 공동 작업 환경을 제공합니다.

혼자가 아닌 여럿이서 워드 프로세서로 매뉴얼을 작성하면 여간 불편한 것이 아닙니다. 공동 작업을 위해 여럿이 파일을 분리하여 작성하고, 파일 서버나 메일로 다시 취합하는 번거로운 과정을 반복해야 합니다. 이 과정에서 내용이 빠지는 일이 빈번히 발생하고 어긋난 서식을 맞추는 일에 신경을 써야 합니다.

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

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

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

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

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

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

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

프레임메이커와 같은 매뉴얼 작성 도구도 장 단위로 내용을 작성하지만 여럿이 동시에 하나의 장을 편집할 수 없습니다.

그림 -1에디터

마우스 사용을 최소화하고 키보드만으로 글을 쓰게 해주는 다양한 단축키를 제공합니다.

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

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

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

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

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

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

그림 -2웹 뷰어

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

1제목, 그림, 표 차례를 보여줍니다.

2검색 기능을 제공합니다.

3찾아보기를 보여줍니다. 단, 찾아보기 유형 장이 있을 때만 나타납니다.

4링크를 제공합니다.

많은 위키 제품은 PDF 내보내기를 지원하지 않거나 하나의 완성된 PDF 파일을 만들지 못하지만 쓰리래빗츠 북으로는 높은 품질의 PDF 파일을 만들 수 있습니다.

다른 매뉴얼 작성 도구와 달리 사용자에게 PDF 파일을 제공하기 위해서 웹 서버에 파일을 올릴 필요가 없습니다.

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

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

다른 매뉴얼 작성 도구와 달리 사용자에게 EPUB 파일을 제공하기 위해서 웹 서버에 파일을 올릴 필요가 없습니다.

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

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

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

그림 -3단락 유형 설정

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

그림 -4문자 유형 설정

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

그림 -5PDF 내보낼 때 테마와 레이아웃 선택

테마와 레이아웃으로 이루어져 있는 서식 메뉴에서 웹 뷰어, PDF, EPUB 파일 서식을 다양하게 꾸밀 수 있습니다.

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

그림 -6이력 비교

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

그림 -7비주얼 에디터

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

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

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

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

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

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

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

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

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

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

윈도우, 리눅스, 유닉스, 맥 등 다양한 운영체제에서 설치 파일 압축을 풀고, 설치 마법사로 옵션을 설정하는 것만으로 쓰리래빗츠 북을 설치할 수 있습니다.

쓰리래빗츠 북은 자바로 개발한 서버 애플리케이션으로 자바 6 이상을 설치할 수 있는 운영체제를 지원합니다.

그림 -8설치 마법사

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

그림 -9소프트웨어 업데이트

제품을 출시하고 서비스를 개선할 때마다 반복되는 매뉴얼 작성의 비효율을 개선할 목적으로 투자를 결심해봐도 마땅한 방법을 찾지 못했던 많은 분께 쓰리래빗츠 북이 만족스러운 해법이 되기를 희망합니다.