[기술문서/매뉴얼 제작] 소프트웨어(SW) 기술 문서의 유형

//[기술문서/매뉴얼 제작] 소프트웨어(SW) 기술 문서의 유형

[기술문서/매뉴얼 제작] 소프트웨어(SW) 기술 문서의 유형

안녕하세요, Technical Communication(테크니컬 커뮤니케이션) 전문 기업 텍스트리입니다. 자사는 매뉴얼 · 기술문서 제작에 대한 오랜 노하우를 토대로 제품 설명서, 기술 매뉴얼 등 고품질의 문서 제작 서비스를 제공하고 있습니다.

이번시간에는 1, 2부에 나눠 소프트웨어(SW) 기술문서의 유형 및 역할에 대해 말씀을 드리려고 합니다.

1부: 소프트웨어용 기술문서의 필요성과 기술문서의 유형

2부: 소프트웨어용 기술문서의 역할

 

소프트웨어용 기술문서란 무엇입니까?

*프트웨어 엔지니어링 기술문서는 소프트웨어 제품의 ‘개발’ 및 ‘사용’을 위한 모든 문서 · 자료를 포괄하는 상위 용어입니다.

*소프트웨어 엔지니어링: 컴퓨터 소프트웨어의 계획·개발·검사·보수·관리 등을 위한 기술 및 그것을 연구하는 공학의 한 분야

기업의 규모와 관계없이 모든 소프트웨어 제품에는 사용자의 편의를 위한 기술문서가 요구됩니다. 그리고 소프트웨어 개발 수명주기(SDLC) 전체에 걸쳐 다양한 종류의 문서가 생성됩니다. 이 중 소프트웨어 제품 설명서는 제품 기능을 설명하고, 프로젝트 관련 정보를 통합합니다. 이는 이해당사자와 개발자 간에 발생하는 모든 중요한 문제를 토의하기 위한 것이기도 합니다.

소프트웨어 제품 설명서는 개발중인 제품의 기능을 설명할 뿐 아니라 다양한 작업을 수행하는 방법에 대한 지침을 제공합니다.

이에 따라 소프트웨어 제품 설명서는 다음과 같이 분류할 수 있습니다.

소프트웨어 제품 설명서의 종류: 시스템 문서/사용자 설명서

시스템 문서: 시스템 자체와 그 세부 구성을 설명하는 문서를 나타냅니다. 요구사항 문서, 설계 결정, 아키텍처 설명, 프로그램 소스 코드 및 도움말 가이드 등을 포함하고 있습니다.

사용자 설명서: 주로 소프트웨어 제품 최종 사용자와 시스템 관리자를 위해 작성된 매뉴얼이 수록되어 있습니다. 사용자 설명서에는 튜토리얼, 사용자 가이드, 문제 해결 매뉴얼, 설치 및 참조 매뉴얼이 포함됩니다.


 

사용자에 따른 구분 : 최종 사용자/시스템 관리자

사용자 설명서는 제품 사용자를 위해 작성됩니다. 그러나 설명서를 사용하는 대상에 따라 설명서의 카테고리는 다를 수 있습니다. 따라서 다양한 사용자 작업과 다양한 수준의 경험에 따라 사용자 문서를 구성해야 합니다. 일반적으로 사용자 설명서는 크게 두 가지 범주로 나뉩니다.

최종 사용자를 위해 작성된 문서는 소프트웨어가 자신의 문제를 해결하는데 어떻게 도움이 될 수 있는지 가능한 가장 빠른 방법으로 설명해야 합니다. 많은 대형 고객 기반 제품에서 튜토리얼과 온보드와 같은 사용자 설명서의 일부 부분은 소프트웨어에 탑재하여 제공하고 있습니다. 그럼에도 불구하고, 문서화된 사용자 설명서를 필요로 하는 복잡한 시스템은 여전히 남아 있습니다.

사용자 설명서의 온라인 형태는 기술문서 작성자가 더 창의적이어야 합니다. 온라인 최종 사용자 설명서에는 다음 섹션이 포함되어야 합니다.

* FAQs

* 비디오 튜토리얼

* 임베디드 지원

* 서포트 포털

최종 사용자에게 최상의 서비스를 제공하기 위해서는 고객 피드백을 지속적으로 수집해야 합니다. 위키 시스템은 사용자에게 제공하는 서비스를 위해 기존 문서를 유지 관리하는데 보다 유용한 시스템 중 하나입니다. 도움이 됩니다. 위키 시스템을 사용하면 문서 형식으로 내보내고 서버에 업로드 할 필요가 없습니다. 위키 마크 업 언어와 HTML 코드를 사용하여 위키 페이지를 만들 수 있습니다.

시스템 관리자의 문서는 소프트웨어 작동 방법에 대한 정보를 제공 할 필요가 없습니다. 일반적으로 관리 문서에는 시스템 관리자가 제품 유지 관리를 수행하는데 도움이 되는 설치 및 업데이트가 포함됩니다.

표준 시스템 관리자 문서는 다음과 같습니다.

기능 설명 – 제품의 기능을 설명합니다. 이 문서의 대부분은 사용자 또는 소유자와 협의를 통해 작성됩니다.

시스템 관리 설명서 다른 환경 및 다른 시스템에서 시스템의 다양한 유형의 동작을 설명합니다. 또한 오작동 상황을 처리하는 방법에 대한 지침도 제공해야합니다.

텍스트리는 다양한 제품의 사용자 설명서부터 전문적인 반도체 장비, 소프트웨어 기술문서 등 산업 전반에 걸쳐 다양한 분야의 기술문서를 전문적으로 제작해 왔습니다. 홈페이지를 방문해 주시면 기술문서 제작과 관련해서 보다 자세한 내용을 확인해 보실 수 있습니다.

2019-03-05T20:31:30+00:00