사용자 설명서, API 참조, 도움말 센터, 제품 가이드 등 온라인 문서를 PDF 또는 웹 페이지(HTML)로 게시할 수 있습니다. 형식 선택은 사용자가 콘텐츠를 찾고 읽는 방법, 콘텐츠를 얼마나 쉽게 업데이트할 수 있는지, 모바일에서 잘 작동하는지 여부에 영향을 미칩니다. 각각은 진정한 장점을 갖고 있으며 많은 조직에서는 두 가지를 서로 다른 목적으로 사용합니다.
HTML 문서가 더 효과적으로 작동하는 방법
HTML 문서는 웹에 기본으로 제공됩니다. 검색 엔진은 개별 페이지를 색인화합니다. 즉, 특정 주제를 검색하는 사용자는 파일을 다운로드하여 검색할 필요 없이 관련 섹션으로 직접 이동할 수 있습니다. Google에서 '제품 비밀번호 재설정 방법'을 검색해 보세요. 사용자를 도움말 콘텐츠의 47페이지로 바로 안내할 수 있습니다. 이는 다운로드 링크 뒤에 있는 PDF로는 불가능한 일입니다.
HTML은 어떤 화면에도 적용됩니다. 모바일 사용자는 고정 레이아웃 페이지를 확대/축소하거나 스크롤하지 않고도 문서를 읽을 수 있습니다. 파일을 교체하지 않고도 콘텐츠를 업데이트할 수 있습니다. 오타를 수정하거나 스크린샷을 업데이트하면 변경 사항이 모든 사용자에게 즉시 적용됩니다. 그리고 HTML 문서에는 사용자가 한 번의 클릭으로 복사할 수 있는 코드 샘플, 확장 가능한 섹션, 삽입된 비디오, 모든 콘텐츠에 대한 실시간 검색 등 대화형 요소가 포함될 수 있습니다.
PDF 문서가 유리한 곳
PDF 문서는 오프라인에서 작동합니다. 설명서를 다운로드한 사용자는 비행기 안, 연결이 제한된 데이터 센터, 전화가 허용되지 않는 환경에서 장비를 사용하여 작업할 때 인터넷 접속 없이도 읽을 수 있습니다. 하드웨어 문서, 산업 매뉴얼 또는 현장에서 사용되는 기술 참조의 경우 이는 상당한 실질적인 이점입니다.
PDF는 또한 안정적으로 인쇄할 수 있는 고정 레이아웃을 유지합니다. 기술자가 인쇄된 체크리스트나 설치 안내서를 사용하여 작업해야 하는 경우 매번 올바르게 인쇄되는 PDF는 다양한 브라우저와 프린터에서 예기치 않게 형식이 다시 지정될 수 있는 HTML보다 낫습니다.
특정 제품 버전을 나타내는 공식 문서(소프트웨어 버전 3.2용 설명서, 특정 제품 릴리스 사양)의 경우 PDF는 변경되지 않는 고정 레코드를 생성합니다. HTML 문서는 항상 최신 상태이므로 일반적으로 좋지만, 특별히 버전을 지정하지 않으면 문서의 이전 버전이 보존되지 않을 수 있습니다.
검색 가능성: 가장 중요한 요소
대부분의 온라인 문서에서는 검색 가능성이 결정적인 요소입니다. 사용자가 Google이나 사이트 검색을 통해 도움말을 검색해야 하는 경우 HTML이 결정적으로 승리합니다. PDF 콘텐츠는 점점 더 검색 엔진에 의해 색인화되지만 세부적으로는 그렇지 않습니다. PDF의 특정 페이지를 가리키는 검색 결과는 질문에 대답하는 HTML 섹션을 직접 가리키는 검색 결과보다 덜 유용합니다.
검색보다는 탐색(사용자가 이미 어디로 가야 할지 알고 있음)을 통해 문서를 주로 찾는 경우 발견 가능성 격차는 덜 중요하고 다른 요인이 작용합니다.
일반적인 하이브리드 접근 방식
많은 문서화 팀에서는 두 가지 형식을 모두 게시합니다. 기본 문서는 검색 가능하고 모바일 친화적이며 항상 최신 상태인 HTML로 제공됩니다. 전체 설명서를 다운로드하거나 인쇄하거나 로컬 사본을 보관하려는 사용자를 위해 동일한 콘텐츠에서 PDF 내보내기가 생성됩니다. Sphinx, MkDocs 및 GitBook과 같은 도구는 최소한의 추가 노력으로 동일한 소스 콘텐츠에서 두 출력을 모두 생성할 수 있습니다.
이 혼합 방식은 하나의 형식만 선택하는 데 따르는 장단점을 방지합니다. 온라인 사용자는 검색 가능하고 반응성이 뛰어난 HTML 경험을 얻을 수 있습니다. 오프라인 또는 인쇄 가능한 버전이 필요한 사용자는 깔끔하고 형식이 잘 지정된 PDF를 얻을 수 있습니다. 콘텐츠는 한곳에서 유지 관리되고 두 가지 형식으로 게시되므로 추가 유지 관리 부담이 없습니다.
하나를 선택해야 하는 경우
문서가 주로 온라인에서 사용되는 경우, 검색 엔진 가시성이 중요한 경우, 콘텐츠가 자주 변경되는 경우, 모바일 액세스가 중요한 경우 HTML을 선택하십시오. 사용자에게 오프라인 액세스가 필요하거나, 문서를 인쇄해야 하거나, 제품의 고정 버전을 나타내거나, 독립 실행형 파일로 배포해야 하는 경우 PDF를 선택하세요. 대부분의 최신 소프트웨어 제품 및 서비스의 경우 PDF 다운로드 옵션이 포함된 HTML 문서는 두 가지 기반을 모두 효율적으로 다룹니다.