자료찾기 귀찮아 내가 만든 블로그

같은 내용의 HTML Help이라 하더라도 HTML Help가 표시되는 윈도우 모양이나 크기, 스타일에 따라 가독성이나 편리성이 다를 수 있다. 때문에 소프트웨어 도움말로서 HTML Help를 만드는 경우라면 소프트웨어를 주로 사용할 집단의 취향에 맞게 윈도우 모양을 설계하는 것이 중요하다.

HTML Help 저작 프로그램에서는 윈도우 모양을 쉽게 변경할 수 있는 옵션들을 제공하고 있는데 이번 시간에는 HTML Help Workshop를 이용하여 일반적으로 많이 사용하는 옵션 설정 방법과 함께 컴파일한 HTML Help를 디컴파일하는 방법에 대해서 살펴보겠다.

HTML Help 꾸미기
HTML Help Workshop에서는 HTML Help를 꾸밀 수 있는 다양한 옵션을 제공하기 때문에 이미 컴파일한 파일도 몇 가지 설정만 변경하면 쉽게 다른 형태의 HTML Help로 만들 수 있다. 윈도우 모양에 대한 설정은 보통 Project 탭에서 Add/Modify window definitions 단추를 눌러 변경할 수 있으며, 기존 HTML Help에 변경한 설정을 반영하려면 다시컴파일해야 한다.

윈도우 위치와 크기 변경하기
HTML Help를 처음 실행할 때 윈도우가 나타날 위치와 크기를 설정하는 방법은 다음과 같다.

1. HTML Help Workshop에서 프로젝트 파일(*.hhp)을 연 뒤, Project 탭에서 Add/Modify window definitions 단추를 누른다.
2. Position 탭을 선택한 뒤, 'Window size and position'의 'Left'와 'Top', 'Width', 'Height'에 적절한 수치를 입력한다. 이 때 각 수치의 단위는 픽셀이며, 'Left'와 'Top'은 HTML Help가 나타나는 위치이고 'Width', 'Height'는 HTML Help의 폭과 높이이다. 만약 처음 HTML Help를 실행할 때만 작업자가 설정한 위치와 크기로 실행되고 이후에는 사용자가 재조정한 위치와 크기로 실행되게 하려면 'Save user defined window position after first use'를 선택한다.
3. Navigation Pane 탭을 선택한 뒤, 'Navigation Pane width'에 내비게이션 창의 너비를 입력한다. 내비게이션 창의 너비는 목차의 1단 항목이 모두 표시될 정도(약 250픽셀)로 지정하는 게 좋으며, 3 과정에서 입력한 'Width'값보다 작아야 한다.
   
   

도구 모음 구성 바꾸기
도구 모음에 대한 설정을 따로 하지 않은경우 도구 모음에는 숨기기와 뒤로, 인쇄, 옵션 단추가 나타나며, 필요에 따라 다음과같은 방법으로 도구 모음의 구성을 변경할 수 있다.

1. HTML Help Workshop에서 프로젝트 파일(*.hhp)을 연 뒤, Project 탭에서 Add/Modify window definitions 단추를 누른다.
2. Buttons 탭을 선택한 뒤, 'Button Type'에서 도구 모음에 표시할 단추를 선택한다. 각 단추의 용도는 다음과 같다.
   
   

   종류 설명 Hide/Show(숨기기/표시) 내비게이션 창을 숨기거나 표시할 때 사용한다. Locate(위치 보기) 현재 토픽 창에 나타난 토픽의 목차 위치를 확인할 때 사용한다. Back(뒤로) 바로 이전에 보았던 토픽을 확인할 때 사용한다. Forward(앞으로) 'Back'을 선택하기 이전에 보았던 토픽을 확인할 때 사용한다. Home(시작) 시작 파일에 해당하는 토픽을 확인할 때 사용한다. Jump1/2(사용자 지정 텍스트) 작업자가 지정한 문서나 외부 URL로 이동할 때 사용한다. Options(옵션) 여러 가지 옵션을 볼 때 사용한다. Refresh(새로 고침) 토픽 창의 내용을 다시 볼 때 사용한다. Stop(중지) 다운로드하던 정보를 멈출 때 사용한다.

   
   
3. 'Button Type'에서 'Home'이나 'Jump1/2'를 선택한 경우에는 Files 탭에서 단추를 눌렀을 때 토픽 창에 표시할 파일의 경로를 지정한다.

글꼴과 언어 설정하기
토픽 문서를 한글이 아닌 영어나 일본어등으로 작성했다면 해당 언어에 맞게 HTML Help의 언어 설정을 해야한다. 또한 토픽 창과 내비게이션 창의 글꼴이나 크기를 맞추어 전체디자인을 맞추는 것이 좋다. 내비게이션 창의 글꼴과 언어 설정을 하는방법은 다음과 같다.

1. HTML Help Workshop에서 프로젝트 파일(*.hhp)을 연 뒤, Project 탭에서 Change project options 단추를 누른다.
2. General 탭을 선택한 뒤, 'International settings'의 'Language'와 'Font'에 언어와 글꼴, 크기 등을 설정한다. 특히 HTML Help가 영어나 일본어로 작성한 것이라면 언어 설정을 '영어'나 '일본어'로 변경해야 내용이 제대로 나타난다.
3. 만약 목차 탭이나 색인 탭과 같인 특정한 탭의 글꼴만 변경하려면 Contents 탭이나 Index 탭에서 properties 단추를 눌러 설정을 변경하면 된다. 참고로 산돌광수체나 한양체 등과 같이 특별한 글꼴을 지정한 경우 해당 글꼴이 없는 컴퓨터에서는 기본 글꼴로 나타나므로 되도록 굴림이나 바탕체와 같은 Windows 기본 글꼴을 이용하는 것이 좋다.

목차 아이콘 모양 바꾸기
목차 아이콘에 대한 설정을 따로 하지 않은 경우 HTML Help의 목차 탭에는 <그림1>과 같이 각 목차 항목 앞에 폴더나 문서 모양의 아이콘이 표시된다. 폴더 모양의 아이콘은 하위 토픽이 있는 카테고리 목차임을나타내며, 문서 모양은 각각의 독립적인 토픽임을 나타낸다. 이 아이콘모양을 <그림 2>와 같이 변경하는 방법은 다음과 같다.

<그림 1> 기본 목차 아이콘		<그림 2> 수정한 목차 아이콘

1. HTML Help Workshop에서 프로젝트 파일(*.hhp)을 연 뒤, Contents 탭에서 Contents properties 단추를 누른다.
2. General 탭에서 'Use folders instead of books'를 선택 해제한 뒤, 확인 단추를 누른다. 이렇게 하면 전체 목차 항목의 아이콘 모양을 변경할 수 있다.
3. 만약 일부 항목의 아이콘만 변경하려면 General 탭에서 원하는 목차 항목을 선택한 뒤, Edit selection 단추를 누른다. 그리고 Advanced 탭의 'Image index'에서 원하는 아이콘 모양을 선택하면 된다.

목차 스타일 설정하기
HTML Help를 실행했을 때 보통 제일 먼저보고 많이 보는 것이 목차 탭인데 이 목차 탭에 적용할 수 있는 스타일종류과 방법은 다음과 같다.

1. HTML Help Workshop에서 프로젝트 파일(*.hhp)을 연 뒤, Contents 탭에서 Contents properties 단추를 누른다.
2. Styles 탭에서 Add 단추를 눌러 원하는 스타일을 추가한다. HTML Help Workshop에서 제공하는 스타일 중에서 몇 가지만 정리하면 다음과 같다.
   
   

   종류 설명 Plus/Minus squares 목차 앞에 '+', '-' 표시가 나타난다. '+'표시가 있는 목차를 누르면 접혀져있던 하위 목차가 나타난다. Only expand a single heading 하나의 카테고리 목차를 선택하고 다시 다른 카테고리 목차를 선택했을 때 처음 선택했던 목차는 접히고 새로 선택한 카테고리 목차만 펼쳐진 채로 표시된다. Dialog Frame 내 비게이션 창 위에 제목 막대가 추가된다. 이 제목 막대를 누른 상태에서 마우스를 움직이면 내비게이션 창 테두리 내에서 목차를 이동시킬 수 있다. 'Dialog Frame' 스타일을 사용하려면 'Border' 스타일도 함께 추가해야 한다.

디컴파일하기
디컴파일은 이미 컴파일된 HTML Help파일에 포함되어 있는 파일들을 사용자가 지정한 폴더에 복사하는 것을말한다. HTML Help를 구성하고 있는 토픽 문서나 목차 파일, 색인 파일등과 같은 구성 파일이 없더라도 컴파일된 HTML Help(*.chm) 파일을가지고 있는 경우라면 디컴파일하여 모든 구성 파일을얻을 수 있다. 단, 프로젝트 파일(*.hhp)은 디컴파일해도 얻을 수 없기때문에 디컴파일한 파일을 다시 HTML Help로 컴파일하려면 프로젝트파일을 새로 만들어야 한다.

1. HTML Help Workshop 메뉴에서 File > Decompile을 선택한다.
2. 'Destination folder'에는 디컴파일한 결과 파일들을 저장한 위치를 지정하고 'Compiled help file'에는 디컴파일한 HTML Help 파일(*.chm)의 위치를 지정한 뒤, OK 단추를 누른다.
3. 디컴파일된 파일 개수를 확인하는 메시지 상자가 나타나면 확인 단추를 누른다. 2 과정의 'Destination folder'에서 지정한 폴더를 열어 결과를 확인한다.

지 금까지 5회에 거쳐 HTML Help Workshop을 이용한 HTML Help를 만드는 방법에대해 살펴보았다. 정해진 분량과 시간 안에서 기본적인 내용 위주로살펴보았기 때문에 아쉬운 부분이 없진 않지만 이 부분에 대해 관심있었던사람들에게 유용한 길잡이가 되었기를 바란다. 다음 시간부터는 HTML Help를 만들었던 토픽 파일들을 매뉴얼용 문서로 만드는 방법에 대해 살펴보겠다.

출처 : 김유진 ( (주)세중 나모 인터랙티브 개발본부 )

하나의 요리를 완성하기 위해 준비한 식재료들을 한데 모아 조리해야 하는 것처럼 HTML Help 프로젝트를 모두 구성한 다음 완성된 HTML Help를 얻으려면 컴파일 과정을 거쳐야 한다.

컴파일은 작업자가 직접 관여할 수 없는 과정이기 때문에 전문 저작 프로그램을 사용하여 HTML Help를 컴파일해야 한다. 이번 시간에는 HTML Help Workshop을 이용하여 지금까지 작업한 파일들을 컴파일하고 테스트하는 방법에 대해 살펴보겠다.

프로젝트 컴파일하기
이미 토픽 파일들(*.html)과 프로젝트 파일(*.hhp), 목차 파일(*.hhc), 색인 파일(*.hhk) 등이 완성되어 있다면 바로 컴파일하여 HTML Help를 만들 수 있다. 하지만 자신이 원하는 결과물을 얻기 위해서는 컴파일 과정에 앞서 관련 옵션 설정이 제대로 되어 있는지 확인해 두는 것이 좋다. 기본적인 옵션에 대한 설정은 Project 탭에서 Change project options 단추를 누르면 나타나는 Options 대화 상자와 Add/Modify window definitions 단추를 누르면 나타나는 Window Types 대화 상자에서 확인할 수 있다.

• 각 탭에 대한 설정을 확인한다.Options 대화 상자의 Files 탭과 Window Types 대화 상자의 Files 탭에서 HTML Help의 목차 파일과 색인 파일이 제대로 연결되어 있는지 확인한다. 그리고 Window Types 대화 상자의 Navigation Pane 탭에서 검색 탭과 즐겨찾기 탭에 대한 설정을 확인한다. HTML Help에서 검색 기능을 제대로 사용하려면 Options 대화 상자의 Compiler 탭에서 'Compile full-text search infomation'을 선택해야 한다.
  
• HTML Help가 생성되는 위치와 파일 이름을 확인한다.Options 대화 상자 Files 탭의 'Compiled file'에 지정된 경로와 파일 이름(*.chm)이 올바른지 확인한다.
  
• 윈도우 설정을 확인한다.Options 대화 상자 Default 탭의 'Default window'에서 HTML Help를 표시할 윈도우 이름을 확인한다. 그리고 Window Types 대화 상자의 General 탭과 Navigation Pane 탭을 열어 'Window Type'에 동일한 윈도우 이름이 지정되어 있는지 확인한다.
  
• 시작 파일이 제대로 설정되어 있는지 확인한다.시작 파일이란 HTML Help를 실행했을 때 토픽 창에 처음 나타나는 파일을 의미한다. 시작 파일을 별도로 지정하지 않은 경우 Project 탭의 FILES 섹션 가장 위에 있는 파일이 자동으로 지정된다. 시작 파일은 Options 대화 상자 General 탭의 'Default File'과 Window Types 대화 상자 Files 탭의 'Default'에서 확인하거나 변경할 수 있다.
  
• 토픽 파일이 모두 추가되어 있는지 확인한다.Project 탭의 FILES 섹션에서 파일 목록을 확인하고 문제가 있다면 도구 막대에서 Add/Remove topic files 단추를 눌러 파일을 추가하거나 삭제한다. 토픽 파일(*.html)에 사용한 스타일 시트(*.css)와 스크립트 파일(*.js), 스타일이나 스크립트를 이용하여 삽입한 그림 파일을 HTML Help에서 제대로 확인하려면 이 파일들도 목록에 추가해야 한다.

위와 같은 컴파일 관련 옵션을 살펴보았다면 다음과 같은 방법으로 프로젝트를 컴파일한다.

1. HTML Help Workshop에서 컴파일할 프로젝트 파일(*.hhp)을 연다.
2. 메뉴에서 File > Compile을 선택하거나 Project 탭의 도구 막대에서 Save all files and compile 단추를 누른다.
3. Create compiled file 대화 상자가 나타나면 프로젝트 파일의 경로를 확인하거나 Browse 단추를 눌러 프로젝트 파일을 선택한다. 컴파일하기 전에 파일을 저장하려면 'Save all files before compiling'을 선택한다.
4. Compile 단추를 눌러 컴파일을 시작한다. 컴파일 과정 및 결과 메시지가 프로그램 오른쪽 창에 나타난다.

<그림 1>정상적으로 컴파일이 진행된 경우		<그림 2>컴파일 중에 오류가 발생한 경우

정상적으로 컴파일된 경우에는 프로그램 오른쪽 창에 <그림 1>과 같이 나타나지만 경우에 따라 <그림 2>와 같이 오류 메시지가 나타나는 경우도 있다. 오류 메시지가 나타나는 경우에는 오류 메시지의 원인을 확인하고 문제를 수정한 뒤 다시 컴파일을 해야 한다. HTML Help Workshop에서 확인할 수 있는 오류 메시지 종류와 원인은 대략 다음과 같다.

종류 설명 Note 컴파일된 HTML Help를 실행했을 때 심각한 문제가 발생하지는 않지만 작성자가 알고 있어야 하는 정보를 표시한다. 1000에서 2999에 해당하는 메시지 번호를 갖는다. Warning HTML Help에 결함이 있는 경우에 나타나며 3000에서 4999에 해당하는 메시지 번호를 갖는다. Error HTML Help가 빌드될 수 없거나 빌드 중에 문제가 발생했을 때 나타나며 5000에서 6999에 해당하는 메시지 번호를 갖는다. 대표적인 Error 메시지의 종류와 해결 방법은 다음과 같다. HHC5003: Error: Compilation failed while compiling dlg-preview.htm. 메시지에 나타난 파일(예: dlg-preview.htm)이 프로젝트 파일에는 지정되어 있지만 실제 폴더에는 없거나 파일 이름이 프로젝트 파일에 지정된 이름과 다른 경우에 발생한다. HHC5010: Error: Cannot open "c:\Zdnet\GIF-help\namoanigif.chm". Compilation stopped.프로젝트 파일에 지정해 놓은 HTML Help에 접근할 수 없어 컴파일이 중단된 경우 나타난다. 지정해 놓은 이름의 HTML Help(*.chm)가 열려있는지 확인하거나 해당 파일의 속성이 읽기 전용으로 되어 있는지 확인한다. HHC5013: Error: URL reference in the TOC cannot be resolved: "sample.htm".목차 파일에서 연결한 토픽 파일이 실제 폴더에 없거나 파일 이름이 목차 파일에 지정된 이름과 다른 경우에 발생한다. Internal Error HTML Help Workshop 프로그램의 내부 오류로 인해 나타나며 7000번 이상의 메시지 번호를 갖는다.

HTML Help 테스트하기
컴파일이 완료되었으면 작업 폴더에서 생성된 HTML Help(*.chm)를 직접 더블 클릭하여 실행하거나 HTML Help Workshop의 도구 막대에서 View compiled file 단추를 눌러 확인한다. 프로젝트가 성공적으로 컴파일되었으면 <그림 3>과 같은 HTML Help가 실행될 것이다.

<그림 3>컴파일된 HTML Help

실행된 HTML Help에서 모든 기능이 제대로 작동하는지 확인해 본다. 특히 HTML Help를 단순한 자료 백업이나 개인 용도가 아닌 소프트웨어의 도움말로서 제공할 목적이라면 테스트 가이드라인을 구체적으로 정리하여 꼼꼼하게 테스트해야 한다.

• 내비게이션 창에 각 탭이 제대로 나타나는지 확인한다.
• 목차 탭에서 각 목차 항목에 대한 토픽이 토픽 창에 제대로 나타나는지 확인한다.
• 색인 탭에서 선택한 키워드에 대한 토픽이 토픽 창에 나타나는지 확인한다.
• 검색 탭에서 검색이 제대로 되는지 확인한다.
• 도구 모음의 버튼이 제대로 실행되는지 확인한다.
• 각 토픽 파일에 삽입한 하이퍼링크가 제대로 작동하는지 확인한다.
• 토픽 파일에 스타일이나 스크립트, 그림 등이 제대로 나타나는지 확인한다.
• 토픽 파일에서 맞춤법이나 표현이 올바른지 확인한다.

이번 시간에는 프로젝트를 컴파일하고 테스트하는 방법에 대해서 살펴보았다. 지금까지의 작업 과정에서는 대부분 프로그램의 기본 설정을 사용했기 때문에 원하는 것과 다른 형태의 HTML Help가 만들어졌을 수도 있다. 따라서 다음 시간에는 작업자의 취향이나 목적에 맞는 HTML Help를 만들 수 있도록 HTML Help Workshop에서 관련 옵션을 설정하는 방법과 완성된 HTML Help를 디컴파일하는 방법에 대해서 살펴보겠다.

출처 : 김유진 ( (주)세중 나모 인터랙티브 개발본부 )

일반적으로 HTML Help는 수십 개 내지는 수백 개의 토픽 파일(*.html)로 구성되어 있으며 대부분의 HTML Help에서는이것을 몇 개의 카테고리로 나누어 정리한 목차를 제공한다. 하지만 카테고리의 숫자가 많거나 자신이 원하는 정보에 대한 사전 지식이 없을 경우 목차에서 필요한 정보를 찾기는 쉽지 않다. 이번 시간에는 이런 문제를 보완할 수 있는 색인 탭과 검색 탭 등을 HTML Help에 추가하는방법에 대해서 살펴보겠다.

색인 파일 만들기

색인 파일(*.hhk)은 내비게이션 창의 색인 탭에 나타날 키워드(Keyword)에 대해 정의한 텍스트 파일로 색인 탭은 사용자가 자신이 찾으려는 도움말의 주제를 잘 알지 못하거나 필요한 정보가 목차의 어느 카테고리에 속하는지 모를 경우 사용한다. 그러므로 색인을 만들 때에는 고급 사용자뿐 아니라 초보자도 인지할 수 있는 키워드를 추가하고 이에 맞는 토픽 파일을 연결하여 키워드만으로도 원하는 정보를 찾을 수 있게 해야 한다.

색인을 만드는 방법에는 두 가지가 있는데 하나는 색인 파일을 따로 만드는 것이고 다른 하나는 각각의 토픽 파일(*.html)에 KLink(Keywordlink) 키워드를 삽입한 다음 컴파일 중에 자동으로 KLink 키워드를 뽑아 색인을 만드는 방법이다. KLink 키워드를사용하면 별도로 색인 파일을 만들 필요없이 토픽 파일을 작성하면서 동시에 키워드를 지정할 수 있다는 장점이 있다. 하지만 작업 중에는색인의 전체 구조를 파악하기 어렵고, 키워드를 수정해야 할 경우에는 해당 키워드가 삽입된 토픽 파일을 일일이 찾아야 하는 번거로움이 있기 때문에 규모가 큰 HTML Help를 만드는 경우라면 색인 파일을 따로 만들어 사용하는 것이 좋다. 색인 파일은 메모장과 같은 텍스트 에디터에서 직접 관련 소스를 입력하여 만들 수도 있지만 여기에서는 HTML Help Workshop의Index 탭을 이용하여 색인 파일을 만드는 방법에 대해서 살펴보겠다.

1. HTML Help Workshop에서 index 탭을 선택한다. Index Not Specified 대화 상자가 나타나면 'Create a new index file'을 선택한 뒤, OK 단추를 누른다.
   
2. 다른 이름으로 저장 대화 상자가 나타나면 프로젝트 파일(*.hhp)이 저장되어 있는 폴더를 선택한 뒤, '파일 이름'에 적절한 이름(예: index.hhk)을 입력하고 저장 단추를 누른다.
   
3. Index 탭이 빈 상태로 열리면 도구 막대에서 Insert a keyword
   단추를 누른다.
   
4. Index Entry 대화 상자에서 General 탭을 선택한 뒤, 'Keyword'에 원하는 키워드를 입력하고 Add 단추를 누른다. Path or URL 대화 상자가 나타나면 'File or URL' 옆의 Browse 단추를 눌러서 색인 탭에서 키워드를 클릭했을 때 나타날 토픽 파일(*.html)을 선택한 뒤 OK 단추를 누른다. 만약 하나의 키워드에 여러 개의 토픽 파일을 연결하려면 Index Entry 대화 상자에서 다시 Add 단추를 눌러 관련 토픽 파일들을 추가하면 된다.
   
5. Index Entry 대화 상자에서 확인 단추를 누른다.
   
6. 원하는 키워드를 모두 추가할 때까지 3~5 과정을 반복한다. 키워드를 추가할 때에는 추가하려는 키워드가 나타날 위치 바로 위에 있는 키워드를 선택한 상태에서 추가하면 된다.
   
7. 나 와 같은 단추를 이용하여 키워드의 위치를 적절히 정한다. 만약 1단으로 구성된 키워드가 아닌 2단 이상으로 구성된 키워드를 만들려면 단추를 이용하여 키워드의 수준을 낮추면 된다. 그리고 추가한 색인을 가나다순 또는 abc순으로 정렬하려면 도구 막대에서 Sort keywords alphabetically 단추를 누른다.
   

   <그림 1>1단으로 구성된 색인

   
   

   <그림 2>2단으로 구성된 색인

   
   
8. 필요한 키워드를 모두 추가했으면 Contents 탭의 도구 막대에서 Index properties 단추를 눌러 색인 탭에 대한 스타일 설정을 한 뒤, 메뉴에서 File > Save Project를 선택하여 수정한 내용을 저장한다.

검색 탭과 즐겨찾기 탭 추가하기
만약 색인에 없는 키워드를 이용하여 정보를 찾거나 작업자가 선별하여 연결한 토픽 파일 외에 HTML Help를 구성하는 전체 토픽 파일을 대상으로 정보를 검색할 수 있게 하려면 검색 탭을 추가하면 된다. 별도로 목록을 만들어야 하는 목차 탭이나 색인 탭과 달리 검색 탭은 HTML Help Workshop에서 관련 옵션만 선택하여 간단하게 만들 수 있다. 단, 검색 탭이나 즐겨찾기 탭에 대한 설정을 하기 위해서는 먼저 HTML Help를 표시할 윈도우에 대해 정의해야 하는데 자세한 방법은 다음과 같다.

1. HTML Help Workshop에서 프로젝트 파일(*.hhp)을 연 뒤, Project 탭에서 Add/Modify window definitions 단추를 누른다.
   
2. Add a New Windows Type 대화 상자에서 HTML Help가 표시될 윈도우의 이름을 영어나 숫자(예: mainhelp)로 입력한 뒤, OK 단추를 누른다. Window Types 대화 상자가 나타나면 General 탭의 'Title bar text'에 HTML Help의 제목 막대에 표시할 이름(예: 나모 GIF 애니메이터 도움말)을 입력한다.
   
3. Window Types 대화 상자에서 Navigation Pane 탭을 선택한 뒤, 'Window with navigation pane, topic pane, and button'을 선택한다.
   
4. 세부 옵션이 나타나면 'Tabs' 아래에서 'Search tab'을 선택한다. 고급 검색 기능을 추가하려면 'Advanced' 옵션도 선택한 뒤, 확인 단추를 누른다.
   

   <그림 3>일반 검색 기능

   
   

   <그림 4>고급 검색 기능

   
   
5. 메뉴에서 File > Save Project를 선택하여 수정한 내용을 저장한다.

검 색 탭을 추가하는 것처럼 즐겨찾기 탭 역시 간단한 방법으로 추가할 수 있다. 즐겨찾기 탭은 사용자가 자주 이용하는 토픽 파일을 등록해 놓고 이후에는 바로 확인할 수 있게 하는 기능이다. 다른 기능에 비해 많이 사용되지는 않지만 규모가 큰 HTML Help를 만드는 경우에는 자주 참고하는 정보를 등록하여 정보 검색에 소요되는 시간을 절약할 수 있도록 추가해 주는 것이 좋다.

1. HTML Help Workshop에서 프로젝트 파일(*.hhp)을 연 뒤, Project 탭에서 Add/Modify window definitions 단추를 누른다.
   
2. Window Types 대화 상자에서 Navigation Pane 탭을 선택한다. 'Window type'에서 즐겨찾기 탭을 추가할 윈도우 이름(예: mainhelp)을 선택하고 'Tabs' 아래에서 'Favories tab'을 선택한 뒤, 확인 단추를 누른다.
   
3. 메뉴에서 File > Save Project를 선택하여 수정한 내용을 저장한다.

이 번 시간에는 색인 탭과 검색 탭, 즐겨찾기 탭을 추가하는 방법에 대해서 살펴보았다. 지금까지 살펴본 내용을 학습하여 활용한다면 어떠한 형태의 HTML Help라도 충분히 만들 수 있을 것이다. 다음 시간에는 그 동안 작업한 모든 파일을 컴파일하여 최종 결과물인 CHM(*.chm) 파일을 만들고 테스트하는 방법에 대해서 살펴보겠다.

출처 : 김유진 ( (주)세중 나모 인터랙티브 개발본부 )

HTML Help에 대한 시스템을 목적에 맞게 설계하여 이에 따라 구성 파일들 즉, 토픽 파일과 그림 파일, 스타일 시트, 스크립트 파일 등을 만들었다면 이제는 이 파일들을 관리할 수 있는 프로젝트 파일(*.hhp)을 생성하고 사용자가 전체 문서 구조를 한번에 파악할 수 있도록 목차 파일(*.hhc)을 만들어야 한다.

프로젝트 파일이나 목차 파일은 텍스트 파일이기 때문에 메모장과 같은 텍스트 에디터를 이용해서도 만들 수 있지만 관련 소스에 대해 따로 학습해야하고 큰 규모의 프로젝트를 진행할 경우 작업 시간이 오래 걸릴 수 있으므로 쉽게 파일을 생성하고 관리할 수 있는 전문 저작 프로그램을 사용하는 것이 좋다. HTML Help 형식의 도움말을 만들 수 있는 프로그램으로는 eHELP의 Robohelp와 MS 사의 HTML Help Workshop, ComponentOne 사의 Doc-To-Help, EC Software 사의 Help&Manual 등이 있는데 여기에서는 비교적 사용 방법이 간단하고 무료로 다운로드 받아 사용할 수 있는 MS 사의 HTML Help Workshop 1.31을 이용하여 프로젝트 파일과 목차 파일을 만들고 나아가서는 최종 컴파일 결과물인 CHM 파일을 만드는 방법에 대해서 살펴보겠다.

프로젝트 파일 만들기
HTML Help의 프로젝트 파일(*.hhp)은 HTML Help 프로젝트의 여러 가지 요소를 하나로 묶어놓은 파일로 HTML로 작성된 토픽 파일(*.html), 그림 파일(*.jpg, *.gif, *.png), 색인 파일(*.hhk), 목차 파일(*.hhc) 등을 모두 컴파일한 HTML Help(*.chm)로 만들기 위해 필요한 정보가 포함되어 있다. HTML Help Workshop을 이용하여 프로젝트 파일을 새로 생성하는 방법은 다음과 같다.

1. HTML Help Workshop을 실행한 뒤, 메뉴에서 File > New를 선택한다.
2. New 대화 상자가 나타나면 'Project'를 선택한 뒤, OK 버튼을 누른다.
3. New Project 대화 상자가 나타나면 다음 단추를 누른다.
4. New Project - Destination 대화 상자가 나타나면 Browse 단추를 눌러 프로젝트 파일을 저장할 위치(보통 토픽 파일이 저장된 폴더)를 선택하고 파일 이름을 입력한 뒤, 열기 단추를 누른다.
5. New Project - Destination 대화 상자에서 다음 단추를 누르면 나타나는 New Project - Exisiting Files 대화 상자에서 'HTML files(*.htm)'을 선택한 뒤, 다음 단추를 누른다.
6. New Project - HTML Files 대화 상자가 나타나면 Add 단추를 눌러 열기 대화 상자에서 토픽 파일(*.html)을 모두 선택한 뒤, 열기 단추를 누른다. 만약 문서에 그림 파일이나 스타일 시트 등을 사용하였다면 열기 대화 상자의 '파일 이름'에 '*.*'을 입력하고 열기 단추를 눌러 모든 파일이 나타나게 한 다음 파일을 추가한다. 그래야 CHM 파일로 컴파일했을 때 토픽 파일에서 사용한 부속 파일들도 제대로 나타난다.
7. New Project - HTML Files 대화 상자에서 다음 단추를 누르고 New Project - Finish 대화 상자가 나타나면 마침 단추를 누른다. Project 탭에 다음과 같은 내용이 나타나면 성공적으로 프로젝트 파일이 생성된 것이다.
   

   그림 1 프로젝트 파일의 내부 구조

위 과정으로 만든 프로젝트 파일 내부를 살펴보면 <그림 1>과 같이 몇 개의 섹션으로 나뉘어 있는 것을 볼 수 있는데 각 섹션에서 확인할 수 있는 정보는 다음과 같다.

• OPTION: 프로젝트 파일의 기본적인 옵션에 대한 내용이 나타나는 섹션으로 별도로 옵션을 지정하지 않더라도 Compatibility와 Compiled file, Default topic, Display compile progress, Language의 항목이 기본값으로 나타난다. 이 중 'Compiled file'에 표시되는 컴파일 결과 파일(*.chm)의 이름은 위 4 과정에서 지정한 프로젝트 파일 이름과 동일하게 지정되고, 'Default topic'은 FILES 섹션 가장 위에 있는 파일이 자동으로 지정된다. OPTION 섹션에 나타나는 항목에 대한 설정은 Project 탭의 도구 막대에서 Change project options 단추를 눌러 변경할 수 있다.
• WINDOWS: 컴파일된 HTML Help(*.chm)를 실행했을 때 HTML Help가 표시되는 윈도우의 제목과 이름, 크기, 위치 등에 대한 내용이 나타나는 섹션이다. 프로젝트 파일을 만든 뒤, Project 탭의 도구 막대에서 Add/Modify window definitions 단추를 눌러 따로 추가해 주어야 한다.
• FILES: 프로젝트 파일에 추가한 파일 목록이 나타나는 섹션으로 토픽 파일 뿐만 아니라 그림 파일, 스타일 시트, 스크립트 파일 등 추가한 모든 파일에 대한 목록이 나타난다.Project 탭의 도구 막대에서 Add/Remove topic files 단추를 눌러 파일을 추가하거나 삭제할 수 있다.

목차 파일 만들기
위 과정으로 프로젝트 파일(*.hhp)을 만들었다면 이제는 목차 파일(*.hhc)을 만들어 보자. 프로젝트 파일이 HTML Help의 전체 속성에 대해 정의한 파일이라면 목차 파일은 내비게이션 창의 목차 탭에 나타날 내용에 대해 정의한 파일로 목차 탭은 사용자가 자신이 찾으려는 도움말의 주제를 잘 알고 있거나 책을 읽듯이 도움말 전체를 훑어보려고 할 때 주로 사용된다. HTML Help Workshop의 옵션을 이용하여 자동으로 목차 파일을 생성할 수도 있지만 이럴 경우 작업자의 의도와 다른 결과가 나올 수 있기 때문에 번거롭더라도 다음과 같은 과정으로 직접 목차를 추가하는 것이 좋다.

1. HTML Help Workshop에서 Content 탭을 선택한다. Table of Contents Not Specitied 대화 상자가 나타나면 'Create a new contents file'을 선택한 뒤, OK 단추를 누른다.
2. 다른 이름으로 저장 대화 상자가 나타나면 프로젝트 파일이 저장되어 있는 폴더를 선택한 뒤, '파일 이름'에 적절한 이름을 입력하고 저장 단추를 누른다.
3. Content 탭이 빈 상태로 열리면 도구 막대에서 Insert a page 단추를 눌러 목차 항목을 추가한다. Table of Content Entry 대화 상자가 나타나면 'Entry title'에 목차 제목을 입력한 뒤, Add 단추를 누른다. Path or URL 대화 상자가 나타나면 'File or URL' 옆의 Browse 단추를 누른다. 열기 대화 상자에서 목차 항목을 눌렀을 때 토픽 창에 나타날 파일을 선택한 뒤, 열기 단추를 누른다. Path or URL 대화 상자에서 OK 단추를 누르고 Table of Content Entry 대화 상자가 나타나면 확인 단추를 누른다.
4. 만약 여러 개의 하위 목차에 대한 상위 목차 항목을 추가하려면 Insert a heading 단추를 눌러 3 과정과 같은 방법으로 목차 항목을 추가한다. 그리고 나 와 같은 단추를 이용하여 목차 항목의 위치를 적절히 조정한다.
5. 원 하는 목차 항목을 모두 추가할 때까지 3~4 과정을 반복하여 작업하면 되는데 이전 시간에 언급한 것처럼 목차 파일을 만들 때 미리 전체 목차 항목에 대한 구조 파일을 만들어 사용하면 좀더 편리하게 작업할 수 있다.
   

   그림 2 구조 파일에 따라 생성한 목차 항목

6. 필요한 경우 Contents 탭의 도구 막대에서 Contents properties 단추를 눌러 목차 탭에 대한 스타일 설정을 한 뒤, 메뉴에서 File > Save Project를 선택하여 수정한 내용을 저장한다.

이 번 시간에는 프로젝트 파일과 목차 파일을 생성하는 방법에 대해 살펴보았다. 사실 여기까지 작업하고 컴파일해도 기본적인 HTML Help 형태는 갖추기 때문에 사용하는데 있어 큰 불편함은 없다. 하지만 사용자가 원하는 내용을 좀더 쉽게 찾을 수 있도록 색인 탭과 검색 탭도 추가하는 것이 좋을 것이다. 따라서 다음 시간에는 색인 목록을 만들어 색인 탭을 추가하고 검색 탭과 즐겨찾기 탭을 추가하는 방법에 대해서 살펴보겠다.

출처 : 김유진 ( (주)세중 나모 인터랙티브 개발본부 )

프로그램을 사용하다가 궁금한 점이 있으면 보통 [F1] 키를 눌러 프로그램에 대한 온라인 기술 문서(또는 도움말)를 확인하게 된다. 이때 나타나는 도움말 형식에는 여러 가지가 있지만 대부분은 [그림 1]과 같은 HTML Help 형식의 도움말이 나타날 것이다. 여기에서는 이런 형식의 도움말 제작에 대해 평소 관심이 있었던 업체나 사람들에게 하나의 길잡이가 될 수 있도록 HTML Help를 만드는 과정을 5회에 거쳐 진행될 예정이다.

하지만 HTML Help란 말을 처음 듣거나 또는 이에 대해 자세히 알지 못했던 사람이라면 먼저 이런 질문이 떠오를 것이다. 'HTML Help란 무엇이고 어떻게 작동하는 것인가?' 따라서 본격적인 작업에 앞서 HTML Help에 대해 간단하게 살펴보기로 한다.

HTML Help의 개요와 구성
HTML Help는 MS에서 32비트 윈도우 애플리케이션용으로 1997년에 개발되었으며, HTML 형식에 기반을 둔 온라인 도움말의 표준이다. HTML Help의 파일 형식은 '*.chm'이며, 이 파일을 더블 클릭하여 직접 실행하거나 프로그램과 연동되어 있는 경우 관련 메뉴를 선택하거나 F1키를 눌러 실행할 수 있다. 오늘날 다수의 소프트웨어에서 HTML Help를 기본 도움말 형식으로 사용하고 있는데 그 이유를 몇 가지로 요약해 보면 다음과 같다.

• 사용자의 시스템 환경에 거의 영향을 받지 않는다.
  사용자의 시스템에 인터넷 익스플로러 3.01 이상만 설치되어 있으면 인터넷 익스플로러가 기본 브라우저가 아니더라도 HTML Help 형식의 도움말을 사용할 수 있다.
  
• 문서를 동적으로 작성할 수 있다.
  HTML Help가 개발되기 이전에 많이 사용했던 WinHelp와 달리 HTML Help는 HTML 파일(*.htm)로 구성되기 때문에 HTML 파일 자체에서 사용할 수 있는 CSS, DHTML, 스크립트 등의 모든 요소를 활용할 수 있다. 또한 문서 작성 방법이 HTML 파일과 동일하기 때문에 별도로 문서 작성 방법을 학습할 필요가 없다.
  
• 파일 관리가 용이하다.
  여러 개의 HTML 파일과 부속 파일들을 하나의 파일(*.chm)로 컴파일하여 사용할 수 있으며, 필요한 경우 디컴파일하여 쉽게 원래의 상태로 되돌릴 수도 있다. 또한 HTML Help로 컴파일한 파일(*.chm)은 실제 원본보다 훨씬 작은 용량으로 저장할 수 있다. 예를 들어 '나모 웹에디터 FX 도움말'에서 사용한 전체 파일 용량은 약 21MB이지만 HTML Help 형식의 파일(webeditor.chm)로 만들면 약 1/3인 8MB가 된다.

위 와 같은 특성 때문에 HTML Help는 단순히 소프트웨어 도움말로서의 용도뿐 아니라 웹 사이트를 백업하거나 여러 곳에 흩어져 있는 자료를 일목요연하게 정리하는 용도 등으로도 활용된다. 이처럼 여러 용도로 사용할 수 있는 HTML Help는 그 목적이나 작업자의 취향에 따라 여러 형태로 제작할 수 있지만 우리가 흔히 볼 수 있는 HTML Help는 아래와 같은 형태이며, 각 부분의 역할은 다음과 같다.

[그림 1] HTML Help 형식의 도움말 구성

• 도구 모음: 내비게이션 창을 숨기거나 보이게 하는 버튼, 토픽 창에 나타난 내용을 인쇄할 수 있는 버튼 등으로 구성되어 있다. HTML Help를 만들 때 도구 모음에 대한 설정을 별도로 하지 않으면 기본적으로 숨기기, 뒤로, 옵션, 인쇄 단추가 나타나며, 필요에 따라 도구 모음의 구성을 변경할 수 있다.
  
• 내비게이션 창: HTML Help의 왼쪽에 나타나며, 목차 탭, 색인 탭, 검색 탭, 즐겨찾기 탭 등으로 구성된다. 각 탭은 HTML Help의 내용을 쉽고 편리하게 찾을 수 있도록 도와주는 역할을 하며, 작업자가 내비게이션 창에 나타날 탭 종류를 선택할 수 있다.
  
• 토픽 창: HTML Help의 내용을 표시하는 부분으로 앞서 언급한 것처럼 HTML Help는 HTML 파일을 기반으로 하기 때문에 텍스트 뿐만 아니라 그림이나 멀티미디어적 요소, 스크립트 효과 등도 표현할 수 있다. 필요한 경우 내비게이션 창 없이 토픽 창만 나타나도록 HTML Help를 만들 수도 있다.

HTML Help가 어떤 것인지에 대해 대략적으로 이해했다면, 이제부터는 HTML Help 형식의 도움말을 만드는 방법을 살펴보겠다. 다음의 과정으로 소개할 내용을 차근히 따라가다 보면 간단한 도움말 하나를 함께 완성할 수 있을 것이다. HTML Help를 만드는 목적에 따라 도움말 구성이나 작업 과정이 다르기 때문에, 여기에서는 범위를 제한하여 일반적인 도움말 형태를 지닌 '나모 GIF 애니메이터 도움말'을 예로 들어 설명한다.

1. HTML Help 시스템 설계하기
   
2. 프로젝트와 목차 만들기
   
3. 색인 만들기
   
4. 검색 및 즐겨찾기 기능 구현하기
   
5. 컴파일 및 테스트하기
   
6. 기타 옵션 설정하기
   
7. 디컴파일하기

HTML Help 시스템 설계하기
집을 지을 때 정확한 설계도가 있어야 작업에 필요한 인력과 시간, 비용을 미리 예상하여 경제적이고 튼튼한 집을 지을 수 있는 것처럼 HTML Help를 만들 때에도 HTML Help 시스템에 대한 계획을 세워야 시행착오 없이 작업자가 원하는 결과를 도출할 수 있다. 따라서 다음 항목에 대해 살펴보고 계획을 세우는 것은 매우 중요한 일이다.

• HTML Help 대상 정하기
  누구를 대상으로 할 HTML Help를 만들 것인지를 생각한다. 초보 사용자를 대상으로 한다면 기본적인 내용에 대한 설명과 내용을 이해하기 쉽도록 그래픽적 요소를 많이 사용해야겠지만 고급 사용자를 대상으로 한다면 기본적인 내용에 대해서는 간략히 설명하고 대신 고급 기능에 대한 설명을 넣어야 할 것이다.
  
• 내용 기술 방법 정하기
  문서를 어떤 방식으로 기술할 것인지를 정한다. 보통 사용자가 직접 따라하면서 기능을 익힐 수 있는 '따라하기' 식과 각 기능에 대해 풀어서 설명하는 '참고서' 식으로 나눌 수 있다.
  
• 내비게이션 창 구성하기
  내비게이션 창을 구성할 탭의 종류를 정한다. 내비게이션 창을 구성할 탭의 종류에 따라 작업 순서나 시간이 달라질 수 있다. 예를 들어 색인 탭을 추가하는 경우 키워드를 추가하여 색인 파일을 만드는 작업 시간을 더 추가해야 한다.
  
• HTML Help 저작 도구 정하기
  어떤 프로그램을 이용하여 HTML Help를 만드느냐에 따라 문서 작성 방식이 달라질 수도 있다. 예를 들어 HTML 파일에 자바 스크립트를 삽입하여 구현할 수 있는 효과를 프로그램 자체에서 메뉴로 제공하는 경우도 있다.
  
• 폴더 구조 및 파일 이름 정하기
  HTML Help 프로젝트가 큰 경우에는 관련 파일의 개수도 많아지게 된다. 따라서 관련 파일을 쉽게 관리할 수 있도록 폴더 구조를 잘 설정하고 파일 이름만으로도 문서 내용을 파악할 수 있도록 파일 이름을 붙이는 규칙을 미리 만들어 두는 것이 좋다. 여러 명이 프로젝트를 진행하는 경우에는 HTML Help를 구성할 문서의 개수와 파일 이름, 위치 등을 한번에 확인할 수 있도록 아래와 같은 목차 파일을 이용하는 것도 좋은 방법 중의 하나이다.
  
  

  [그림 2] 도움말에 대한 목차 파일

  
  
• HTML 파일 스타일 정하기
  HTML 문서를 작성할 때 공통된 스타일을 유지하려면 스타일 시트(*.css)를 사용하는 것이 좋다. 특히 규모가 큰 프로젝트를 여러 명이 나누어 진행하는 경우에는 아래와 같이 각 요소에 대한 글꼴, 크기, 줄 간격 등에 대한 스타일 시트를 정의하여 공유하는 것이 바람직하다. 마찬가지로 여러 문서에서 공통적으로 사용할 스크립트 효과가 있다면 스크립트 파일(*.js)도 만들어 공유한다.
  
  

  [그림 3] 스타일 시트의 예

  
  

  [그림 4] 스타일 시트가 적용된 HTML Help

위 항목 외에도 문서에 사용할 그림의 크기는 어느 정도로 할 것인지, 내용을 서술할 때 '~합니다'와 같은 '-합쇼'체로 할 것인지 아니면 '~한다'와 같은 '-해라'체로 할 것인지, 'Windows'나 'Microsoft'와 같이 자주 사용하는 외국어 표기는 어떤 식으로 할 것인지 등에 대한 소소한 사항들까지 미리 계획을 세워야 시행착오 없이 일정 안에 작업을 끝낼 수 있다.

지금까지 HTML Help의 개요와 HTML Help 시스템을 설계할 때 고려해야 할 사항들에 대해서 살펴보았다. 다음 시간에는 HTML Help 저작 도구를 선택하여 프로젝트를 만들고 목차를 생성하는 방법에 대해 자세히 살펴보겠다.

출처 : 김유진 ( (주)세중 나모 인터랙티브 개발본부 )

요즘 컴퓨터 관련 잡지나 웹 사이트를 보다 보면 글의 저자를 소개할 때 ‘테크니컬 라이터 아무개’라고 소개하는 것을 볼 수 있다. 불과 몇 년 전만 해도 들어보지 못했던 용어인데 언제부터인가 간간이 이 용어가 눈에 띄기 시작했다. ‘테크니컬’이라는 말이 들어가다 보니 어쩐지 어려워 보이고 생소하게 느껴지기도 하는데, 과연 ‘테크니컬 라이터’는 무엇을 하는 사람들일까? 이 글을 조금만 읽다 보면 곧 그 해답을 찾을 수 있을 것이다.

여기에서는 ‘테크니컬 라이팅’이 무엇이고 ‘테크니컬 문서’에는 어떤 것이 있는지 알아보고 대표적인 온라인 기술 문서인 HTML Help를 중심으로 기술 문서를 만드는 방법에 대해 자세히 알아보기로 한다. 그 첫 번째 시간으로 먼저 ‘테크니컬 라이팅’과 ‘테크니컬 라이터’에 대해 소개하고 본격적인 온라인 기술 문서 작성에 들어가기에 앞서 준비 작업을 해 보기로 한다.

테크니컬 라이팅과 테크니컬 라이터
“테크니컬 라이팅(Technical Writing)은 특정 사람을 대상으로 특정 목적을 가지고 기술적인 주제에 관해 특정 정보를 전달하는 것을 말한다. 테크니컬 라이팅에서 사용하는 문장이나 그림 등은 추상적이지 않아야 한다. 즉, 어떤 작업을 수행하거나 어떤 주제를 이해하기 쉽도록 정확한 정보만을 전달해야 한다.”

위의 정의에서도 알 수 있듯이 테크니컬 라이팅은 일반적인 창작 라이팅과는 달리 특정한 작업을 하려고 하는 사람들이나 특정한 주제에 대해 알고 싶어하는 사람들에게 정확한 사실을 보다 쉽게 전달하는 모든 작업을 포함한다. 따라서 일반적인 창작 라이팅과는 다르게 정보 제공이 그 목적이고 어떻게 하면 그 정보를 좀 더 효율적이고 알기 쉽게 전달할 수 있는가 하는 것이 중점이 된다.

테크니컬 라이팅과 창작 라이팅의 차이

테크니컬 라이팅 창작 라이팅 내용 사실적, 직설적 창의적, 상상, 상징적 대상 특정인 일반인 형식 형식적, 표준, 학문적 자유로운 형식 구성 순차적 원하는 대로 자유롭게

테크니컬 라이팅의 예로는 ‘프리젠테이션 문서’, ‘소프트웨어 문서’, ‘이력서’, ‘작업 가이드’, ‘기사’, ‘회사 소개’ 등을 들 수 있다. 지금 여러분이 보고 있는 이 글도 역시 테크니컬 라이팅에 속한다. 이러한 테크니컬 라이팅의 가장 큰 특징을 요약해 보면 다음과 같다.

• 먼저 표현이 ‘명확’해야 한다. 모호한 설명은 피하고 쉽게 이해할 수 있도록 명확하게 기술해야 한다.
  
• 그리고 ‘사실’만을 전달해야 한다. 저자의 주관적인 생각이나 추측을 기술하는 것이 아니라 정확한 사실만을 기술해야 한다.
  
• 용어나 문법 등이 ‘올바른’ 것이어야 한다. 표준에 맞지 않은 표현이나 용어 등을 사용해서는 안 된다.
  
• 정보 검색이 ‘쉬워야’ 한다. 정보는 많이 제공하면서 원하는 정보를 쉽게 찾을 수 없도록 해 놓으면 정보를 찾기 위한 시간이 너무 많이 소모된다. 따라서 제목과 부제목을 잘 활용하고 목차와 색인을 잘 구성해야 한다.
  
• 주제를 쉽게 이해할 수 있도록 ‘다양하고 풍부한’ 정보를 제공해야 한다.

그렇다면 ‘테크니컬 라이터(Technical Writer)’의 뜻은 이제 쉽게 유추할 수 있을 것이다. ‘테크니컬 라이터’는 위에서 설명한 ‘테크니컬 라이팅’을 하는 사람들을 일컫는 말이다. 테크니컬 라이터는 문서를 작성할 뿐만 아니라 기획, 검수, 애플리케이션 테스트, 도움말 제작 등 다양한 업무를 하기도 한다. 그리고 이렇게 해서 만들어진 작업 결과물을 ‘테크니컬 문서(또는 기술 문서)’라고 부른다.

이제 앞에서 예시한 여러 가지 테크니컬 라이팅 중에 ‘소프트웨어 기술 문서’를 뽑아 이를 보다 자세히 알아보도록 하겠다. 여기에서는 ‘나모 웹에디터 FX suite’의 기술 문서를 예로 하여 소프트웨어 기술 문서의 종류에 대해서 자세히 알아보기로 한다.

소프트웨어 기술 문서
어떤 제품을 처음 접했을 때, 아무런 도움 없이도 제품을 계속 사용하면서 시행착오를 겪다 보면 사용법을 익힐 수 있다. 하지만 보다 빠르고 쉽게, 그리고 최대한 제품을 활용하려면 ‘도움’이 필요하다. 이러한 ‘도움’에는 콜센터와 같은 전화 상담이 있을 수 있고 이미 기능을 알고 있는 주위 사람들의 설명이 있을 수 있고, 책이 될 수도 있고, 멀티미디어 자료가 될 수도 있다.

여러 가지 ‘도움’ 중에 가장 기본적이고 대표적인 방법이 예전에는 ‘매뉴얼’을 제공하는 것이었다. 물론 요즘에도 매뉴얼을 제공하는 업체가 굉장히 많다. 카메라, TV, 휴대폰을 사도 매뉴얼이 있고 소프트웨어를 사도 매뉴얼이 있다. 하지만 최근에는 종이로 된 매뉴얼보다는 온라인 기술 문서를 선호하는 경향이 점점 증가하고 있다.

온라인 기술 문서는 말 그대로 책으로 보는 것이 아니라 컴퓨터(단말기) 화면상에서 볼 수 있는 기술 문서를 말한다. 대표적인 온라인 기술 문서 형식으로는 PDF 문서, HTML Help, 웹 사이트에서 제공하는 기술 문서를 들 수 있다. PDF 문서는 검색, 인쇄 등이 가능하고 프린트로 출력된 문서의 모든 요소를 갖추고 있는 파일 형식이다. Adobe사의 Acrobat과 같은 소프트웨어를 이용하여 만들 수 있으며 PDF 문서를 보려면 Acrobat Reader(아크로뱃 리더)가 설치되어 있어야 한다. HTML Help(*.chm)는 Microsoft사에서 개발한 온라인 도움말 형식으로 현재 대부분의 소프트웨어에서 사용하고 있는 도움말 형식이다.

다음 그림은 전 세계 테크니컬 라이터를 대상으로 가장 많이 사용하는 기술 문서 형식에 대한 설문 조사 결과이다.


<그림 1> 소프트웨어 기술 문서로 가장 많이 사용하고 있는 형식 (출처:http://www.winwriters.com)
여기에서도 볼 수 있듯이 매뉴얼 보다는 PDF 문서나 HTML Help(Browser-based Help), 웹 기술 문서가 점점 대표적인 기술 문서 형식으로 자리잡아가고 있음을 볼 수 있다. 물론 여전히 매뉴얼이 중요하게 여겨지기는 하지만 해가 거듭될수록 매뉴얼의 비율이 낮아지고 있다.

그럼 매뉴얼과 같은 오프라인 문서가 아닌 온라인 기술 문서를 제공할 때 얻을 수 있는 장점은 무엇일까? 여러 가지가 있겠지만 우선 업데이트가 쉽고, 책으로 만드는데 드는 비용이 절감되고, 보다 쉽게 정보를 검색할 수 있고, 다이내믹하게 구성할 수 있다는 점등을 들 수 있다.

온라인 기술 문서의 장점을 정리해 보면 다음과 같다.

• 온라인 기술 문서에서는 원하는 정보를 쉽게 검색할 수 있다.
  책에서 원하는 정보를 찾기 위해서는 목차나 색인을 참조한다 해도 시간이 걸리기 마련이다. 하지만 온라인 도움말에서는 검색 기능을 사용하면 원하는 정보를 보다 쉽고 빠르게 찾을 수 있다. 또한 정보를 찾기 위해 하던 일을 멈추고 책을 찾아 보던 것과는 달리 화면에서 바로 정보를 찾아 적용해 볼 수 있다.
  
• 관련된 정보를 찾아보기 쉽다.
  하나의 정보를 찾고 나서 그와 관련된 또 다른 정보를 보기 위해 다시 목차나 색인을 참고할 필요 없이 다음 그림과 같이 작성자가 제공하는 관련 항목 링크를 클릭하는 것만으로도 관련 정보를 쉽게 찾아 볼 수 있다.

<그림 2> 일반적인 하이퍼링크 형식의 관련 항목 링크

<그림 3> HTML Help 저작 툴을 활용하여 만든 관련 항목 링크

• 판매자 입장에서는 비용을 절감할 수 있다.
  온라인 도움말을 제공하게 되면 책을 만드는데 들어가는 종이, 인쇄, 생산, 배포 등에 소요되는 비용을 줄일 수 있다.
  
• 제공 방법이 쉽다.
  따로 인쇄하는 과정을 거치지 않고 온라인으로 바로 출판하여 제공할 수 있어 복잡한 과정 없이 쉽게 제공할 수 있다.
  
• 업데이트가 쉽다.
  인쇄해서 제공하는 경우에는 문서가 업데이트되면 다시 인쇄해서 책으로 만들어야 하는 번거로움이 따른다. 하지만 온라인 기술 문서는 수시로 업데이트하여 편리하게 제공할 수 있다.

자, 지금까지 '테크니컬 라이팅'의 기본 개념과 '온라인 소프트웨어 기술 문서'에 대해서 살펴보았다. 그럼 다음 번에는 대표적인 온라인 기술 문서 형식인 HTML Help가 무엇인지 알아보고 이를 구성하는 파일에는 무엇이 있는지 살펴보도록 하겠다.

출처 : 김유진 ( (주)세중 나모 인터랙티브 개발본부)