지난 시간까지는 HTML Help와 PDF 매뉴얼를 만드는 과정을 살펴 보았다. 소프트웨어를 만들 때, 프로그램과 도움말, 사용자 매뉴얼까지 갖추었다면 제품을 만들 준비가 거의 다 되었다고 볼 수 있다. 이제 제품을 준비하는 막바지 단계 중의 하나인 리드미 문서에 대해 이야기해 보도록 하겠다. 참고로 여기에서는 리드미 문서의 형식과 내용 구성에 대해 간단하게 살펴볼 것이다. 설치 프로그램에서 리드미 문서를 열거나 시작 메뉴에 바로가기 링크를 등록하는 방법에 대해서는 설치 프로그램을 만드는 소프트웨어의 도움말을 참고하기 바란다.
리드미 문서는 사용자가 소프트웨어를 설치하거나 사용하기 전에 미리 알아 두어야 할 주의 사항이나 간단한 기능 소개를 담고 있는 문서이다. 문서의 파일 이름이 "readme"이기 때문에 리드미 문서라고 불린다. 파일 형식에 따라서 readme.txt이거나, readme.htm, readme.doc 등 확장자가 다르기는 하지만 파일 이름은 "readme"로 사용한다.
리드미 문서 작성하기
많은 사용자들이 프로그램을 설치한 뒤에 뒤에 나오는 리드미 문서를 주의 깊게 읽지 않고 그냥 닫아 버리지만, 프로그램을 처음 설치하고 어떻게 해야 할지 모른다거나, 아예 프로그램을 설치할 때부터 문제가 있는 경우에 가장 빠르게 도움을 받을 수 있는 것이 리드미 문서이다.
리드미 문서의 접근 경로
리드미 문서는 사용자가 프로그램을 설치하거나 실행하기 위해서 미리 알아두어야 할 내용을 담고 있다. 그렇기 때문에 프로그램을 설치하거나 설치한 프로그램을 실행하기 전에 리드미 문서를 볼 수 있어야 한다.
1. CD의 최상위 폴더
프로그램을 CD로 설치를 하는 경우에는 [그림 1]과 같이 CD의 최상위 폴더에 readme.txt 문서나 readme.htm 문서를 넣어 두어서 프로그램을 설치하기 전에 먼저 CD에서 알아두어야 할 내용을 확인 할 수 있도록 한다.
 |
| [그림 1] 나모 웹에디터 FX suite 설치 CD의 리드미 문서 |
그러나 대개는 사용자가 파일을 직접 찾아서 열어보지 않고, CD에서 실행하는 설치 프로그램에서 리드미 문서를 볼 수 있는 메뉴를 제공한다.
 |
| [그림 2] 나모 웹에디터 FX suite 설치 프로그램의 메뉴 |
2. 프로그램의 설치가 끝난 뒤
프로그램을 온라인으로 구입하여 설치 프로그램만을 다운로드하여 사용하는 ESD(Electronic Software Delivery) 형태의 제품에는 CD가 없다. 그리고 체험판으로 제공하는 프로그램이나 공개 자료실과 같은 곳에서 다운로드하여 사용하는 셰어웨어 프로그램이나 프리웨어 프로그램 역시 CD를 제공하지 않고 설치 프로그램만 있는 경우가 대부분이다. 이런 경우에는 프로그램을 설치하기 전에 리드미 문서를 읽어 볼 수 없다. 대신 프로그램의 설치를 마치면 무조건 리드미 문서가 나타나도록 하거나 리드미 문서를 볼 수 있는 선택 사항을 제공하여, 사용자는 프로그램을 실행하기 전에 리드미 문서를 미리 살펴 볼 수 있다.
 |
| [그림 3] 나모 웹에디터 FX 설치 완료 화면 |
 |
| [그림 4] 나모 웹에디터 FX의 리드미 문서 |
3. Winodws의 시작 메뉴
프로그램을 사용하는 도중에도 시작 메뉴나 프로그램이 설치된 폴더를 직접 찾아 들어가면 리드미 문서를 볼 수 있다. 시작 메뉴에서는 프로그램이 설치된 폴더에 있는 리드미 문서를 링크하는 바로가기가 메뉴로 등록된다. 이 메뉴의 이름은 주로 "읽어보세요"나 "꼭 읽어보세요"와 같이 사용자가 쉽게 이해할 수 있는 이름으로 나타난다.
 |
| [그림 5] 나모 웹에디터 FX의 리드미 문서를 볼 수 있는 Winodws의 시작 메뉴 |
리드미 문서의 파일 형식
리드미 문서를 어떤 파일 형식으로 만들어야 한다고 특별히 정해진 것은 없다. 그러나 반드시 지켜야 할 것은 프로그램을 설치한 시스템에서 별도의 프로그램을 설치하지 않고도 읽을 수는 파일 형식이어야 한다는 것이다. 사용자의 컴퓨터 환경은 예측하기 어려울 정도로 다양하기 때문에 특정 프로그램에서만 볼 수 있는 형식으로 리드미 문서를 만들면 사용자가 문서를 읽지 못할 수도 있다.
1. TXT 파일
TXT 형식으로 된 리드미 문서인 "readme.txt"는 DOS 환경에서도 type 등과 같은 내장 명령어를 이용해서 읽을 수 있고, Windows 환경에서도 OS에 내장되어있는 메모장 프로그램으로 읽을 수 있다.
 |
| [그림 6] DOS의 type 명령어로 열어 본 나모 웹에디터 FX suite의 readme.txt |
 |
| [그림 7] Winodws의 메모장에서 열어 본 나모 웹에디터 FX suite의 readme.txt |
readme.txt 파일은 어느 환경에서나 쉽게 읽을 수 있다는 장점이 있다. 그러나 그림과 같은 요소를 넣을 수 없고, 여러 문서를 서로 연결하는 하이퍼링크 기능이 없기 때문에 필요한 내용을 다 넣으려면 문서의 양이 많아지는 단점이 있다.
2. HTML 파일
HTML 형식으로 된 리드미 문서(readme.htm)는 웹 브라우저만 있으면 문서를 쉽게 열어볼 수 있다. 리드미 문서를 HTML 형식으로 작성하면 문서에 그림을 넣거나 스타일을 이용해 문서를 더 보기 좋게 꾸밀 수 있으며, 여러 문서를 하이퍼링크를 이용해 연결할 수 있다.
Windows에는 Internet Explorer라는 웹 브라우저가 이미 설치되어 있기 때문에 최근에는 Windows 환경에서 동작하는 프로그램의 경우에는 HTML 형식으로 된 리드미 문서를 제공하는 경우가 많아졌다.
 |
| [그림 8] 웹 브라우저에서 열어 본 나모 웹에디터 FX suite의 readme.htm |
HTML 형식으로 된 리드미 문서를 작성할 때에는 readme.htm 문서에는 반드시 필요한 내용만을 간략하게 넣고, 내용이 길어지는 기능 소개나 사용 계약서와 같은 문서는 별도의 문서로 작성해서 링크를 시키는 방법을 사용하기도 한다. 또한 고객 지원 안내나 고객 등록과 같은 것은 웹 사이트로 직접 연결할 수도 있다.
HTML 형식으로 리드미 문서를 만들 때 주의할 사항은 웹 브라우저간 호환성을 반드시 확인해야 한다는 것이다. 사용자의 시스템에 설치된 기본 웹 브라우저가 무엇이든 리드미 문서의 내용은 동일하게 나타나야 한다. 그렇기 때문에 리드미 문서에서는 스크립트나 멀티미디어 요소는 넣지 않는 것이 좋다. 특히 플래시와 같이 별도의 플레이어를 설치해야 하는 요소에 중요한 정보를 담으면 사용자는 그 정보를 못 볼 수도 있다.
3. 기타
그 외에도 Windows에 내장된 "워드 패드"로 읽을 수 있는 파일 형식인 RTF나 DOC 형식으로 만든 리드미 문서도 있다. 프로그램이 만약 Windows 용이 아닌 Linux나 Mac과 같은 다른 OS에서 사용하는 것이라면 해당 OS에서 기본으로 내장된 명령어나 프로그램을 이용해 읽을 볼 수 있는 파일 형식이라면 무엇이든 상관없다.
리드미 문서의 내용
리드미 문서에는 사용자가 프로그램을 설치하거나 실행하기 전에 반드시 알아야할 내용이라면 무엇이나 넣을 수 있다. 많은 프로그램의 리드미 문서에서 아래와 같은 내용을 포함하고 있지만, 상황에 따라서 일부를 빼거나 다른 내용을 추가할 수도 있다.
1. 시스템 요구 사항
프로그램을 사용할 수 있는 기본적인 시스템 사양과 설치에 필요한 공간을 명시한다.
시스템 사양에는 프로그램을 사용할 수 있는 운영 체제의 종류, 프로그램을 사용하기 위해서 최소한으로 요구되는 CPU 사양이나 RAM 크기 등을 표기한다. 그 외에 프로그램을 사용하기 위해 미리 설치해야 하는 프로그램이나 있다면 함께 표시한다.
| ||||||
| ||||||
|
2. 사용자 계약서
프로그램을 제공하는 업체와 프로그램을 사용하는 사용자 사이의 사용자 계약서이다. 제품으로 출시하는 상업용 프로그램의 경우에는 범률적인 검토를 마친 사용자 계약서를 넣는 것이 좋다. 상업용이 아닌 무료로 제공하는 프리웨어 프로그램에서는 특별하게 신경을 쓰지 않아도 좋지만, 프리웨어임을 명시해 주는 것이 좋다.
3. 간단한 기능 소개나 개선 사항 목록
프로그램에 대한 간단한 기능 소개를 넣어서, 프로그램이 어떤 기능을 갖고 있는지 알려준다. 버전업을 한 프로그램일 경우에는 버전업을 하면서 개선되거나 추가된 기능을 알려준다. 기능이 적은 프로그램의 경우에는 별도의 도움말이 없이 리드미 문서에서 소개하는 기능 소개가 도움말의 역할을 하는 수도 있다.
4. 프로그램 설치 경로
프로그램이 설치된 경로를 알려준다. 프로그램과 함께 제공하는 샘플과 같은 리소스를 찾거나 할 때 참고할 수 있다.
| |||||||||||||||||||
| |||||||||||||||||||
| |||||||||||||||||||
5. 설치 및 실행과 관련된 정보
프로그램을 설치할 때 주의해야할 사항이 있거나, 설치한 프로그램을 실행하기 전에 미리 준비해야 하는 사항이 있으면 사용자에게 알려주어야 한다. 설치나 실행에 관한 FAQ를 포함할 수도 있다.
6. 고객 지원 정보나 구입 안내
상업용 프로그램일 경우 프로그램에 대해 문의할 수 있는 고객 지원 정보를 알려 준다. 상업용 프로그램이더라도 체험판이나 셰어웨어의 경우에는 고객 지원 정보대신에 구입 안내 등을 넣을 수 있다. 무료로 제공하는 프리웨어 프로그램에서는 프로그램을 사용하는 도중에 발견한 버그를 알릴 수 있는 연락처를 넣는 것도 좋다.
지금까지 아주 간단하게 리드미 문서의 형식과 내용 구성에 대해 설펴 보았다. 리드미 문서는 프로그램이나 정책에 따라서 다양하게 구성할 수 있기 때문에 여기에서는 아주 일반적인 내용만 간단하게 다루었다.
이제 다음 시간에는 지금까지의 강의를 마무리하면서 강의를 마치겠다.
출처 : 김유진 ( (주)세중 나모 인터랙티브 개발본부 )
