매뉴얼 종류
1. HTML 파일
장점
- 웹 형식 유지: 사용자가 웹에서 보는 것과 동일한 형태로 문서를 볼 수 있습니다.
- 다양한 디바이스 호환: 대부분의 디바이스에서 쉽게 열람 가능.
단점
- 상호작용성 제한: 네트워크가 없을 경우 일부 상호작용 기능 제한.
구현 방법
- MkDocs 또는 Sphinx를 사용하여 HTML 파일로 빌드.
- 모든 HTML 파일과 리소스를 압축(zip) 파일로 배포.
2. ePub
장점
- 전자책 형식: 전자책 리더기에서 쉽게 열람 가능.
- 가변 레이아웃: 글자 크기 조절 등 사용자가 읽기 편한 형식으로 조정 가능.
단점
- 복잡한 형식 변환: 일부 레이아웃이나 스타일이 제한될 수 있음.
구현 방법
- Sphinx를 사용하여 ePub 형식으로 빌드.
3. 전자책 (eBook)
장점
- 다양한 플랫폼 지원: Kindle, iBooks 등 다양한 전자책 플랫폼에서 사용 가능.
- 오프라인 접근성: 전자책 리더기에서 언제든지 접근 가능.
단점
- 변환 과정 필요: 다른 형식으로 변환하는 과정 필요.
구현 방법
- Markdown이나 reStructuredText 파일을 eBook 형식으로 변환하기 위해 Pandoc 같은 도구 사용.
4. 설치 가능한 데스크톱 애플리케이션 (StaticSite Manual)
장점
- 독립 실행형: 설치 후 네트워크 없이도 모든 기능 사용 가능.
- 풍부한 인터페이스: 상호작용이 필요한 매뉴얼에 적합.
단점
- 설치 필요: 사용자가 애플리케이션을 설치해야 함.
- 용량 증가: 애플리케이션 크기 증가.
구현 방법
- Electron, Tauri 등을 사용하여 데스크톱 애플리케이션으로 패키징.
5. CHM 파일 (HTML Help)
장점
- 윈도우 네이티브 지원: Windows Help Viewer에서 직접 열람 가능.
- 인터랙티브 콘텐츠 지원: HTML 기반으로 링크 및 멀티미디어 지원.
단점
- 플랫폼 제한: 주로 Windows에서만 사용 가능.
구현 방법
- Sphinx를 사용하여 CHM 형식으로 빌드.
요약
- HTML 파일: 웹 형식을 유지한 채로 오프라인에서 열람 가능.
- ePub: 전자책 형식으로 다양한 디바이스에서 읽기 편리.
- 전자책 (eBook): 전자책 리더기에서 활용 가능.
- 데스크톱 애플리케이션: 설치 후 네트워크 없이 모든 기능 사용 가능.
- CHM 파일: Windows에서 네이티브로 지원되는 도움말 파일 형식.
Buy me a coffee