소프트웨어 개발

제품소프트웨어 매뉴얼 작성

출제기준 세세항목: 제품소프트웨어 매뉴얼 작성 · 국제 표준 제품 품질 특성

핵심 요약

매뉴얼은 개발자가 없는 자리를 대신합니다

소프트웨어를 산 사용자 곁에 개발자가 앉아 있을 수는 없습니다. 사용자가 처음 설치할 때, 기능이 어디 있는지 모를 때, 오류 메시지를 만났을 때 찾아볼 곳이 매뉴얼입니다. 그래서 매뉴얼은 '개발자가 알려 주고 싶은 것'이 아니라 '사용자가 막히는 곳'을 기준으로 써야 합니다.

제품소프트웨어 매뉴얼은 쓰임새에 따라 크게 두 가지로 나뉩니다. 프로그램을 컴퓨터에 깔고 쓸 수 있는 상태로 만들기까지를 안내하는 설치 매뉴얼, 설치된 프로그램의 기능을 어떻게 쓰는지 안내하는 사용자 매뉴얼입니다. 두 문서 모두 제품의 일부로, 패키지와 함께 사용자에게 전달됩니다.

설치 매뉴얼: 처음 30분을 책임지는 문서

설치 매뉴얼은 사용자가 소프트웨어를 처음 만나는 순간을 다룹니다. 여기서 막히면 사용자는 기능을 써 보기도 전에 제품을 포기할 수 있습니다. 그래서 설치 매뉴얼은 개발자 기준의 기술 설명보다, 사용자가 실제로 겪는 순서를 그대로 따라가는 구성이 좋습니다.

먼저 설치 전에 확인할 것을 알려 줍니다. 필요한 운영체제와 하드웨어 사양, 미리 설치해야 하는 프로그램, 기존 자료의 백업처럼 설치 전에 챙겨야 할 준비입니다. 이어서 설치 과정을 단계마다 화면과 함께 보여 주고, 각 단계에서 무엇을 선택해야 하는지 설명합니다. 설치가 끝난 뒤에는 제대로 설치되었는지 확인하는 방법을 알려 줍니다.

잘 쓴 설치 매뉴얼은 설치 이후의 일도 다룹니다. 프로그램을 지우는 삭제 방법, 설치 중 자주 생기는 오류와 그 해결 방법, 해결이 안 될 때 연락할 고객 지원 창구가 그것입니다. 문서 앞부분에는 목차와 함께 이 문서의 목적과 대상 독자, 소프트웨어의 간단한 개요를 두어 사용자가 자기에게 맞는 문서인지 먼저 알 수 있게 합니다.

사용자 매뉴얼: 기능을 제대로 쓰게 하는 문서

사용자 매뉴얼은 설치를 마친 사용자가 기능을 어떻게 쓰는지 안내합니다. 기능마다 무엇을 하는 기능인지, 어떤 화면에서 어떤 순서로 조작하는지, 결과가 어떻게 나오는지를 설명합니다. 사용 중 지켜야 할 주의사항, 데이터 백업 같은 관리 방법, 제품의 모델·버전 정보, 문제가 생겼을 때의 고객 지원 정보도 함께 담습니다.

작성은 보통 큰 틀을 먼저 정하고 내용을 채우는 순서로 진행합니다. 용어와 문체, 화면 캡처 방식 같은 작성 지침을 먼저 정하고, 매뉴얼에 들어갈 구성 요소(목차)를 정의한 뒤, 구성 요소별로 내용을 작성하고, 마지막으로 실제 제품과 맞는지 검토합니다. 지침을 먼저 정해 두어야 여러 사람이 나눠 써도 한 사람이 쓴 것처럼 일관됩니다.

매뉴얼은 제품과 함께 늙습니다. 버전이 바뀌어 메뉴 이름이나 화면이 달라졌는데 매뉴얼이 그대로라면 오히려 사용자를 헷갈리게 만듭니다. 그래서 매뉴얼도 소스 코드처럼 형상관리 대상으로 두고, 릴리즈 노트와 함께 버전에 맞춰 갱신합니다.

품질을 왜 국제 표준으로 말할까요

'이 소프트웨어는 품질이 좋다'는 말은 사람마다 다르게 받아들입니다. 누구는 오류가 없다는 뜻으로, 누구는 빠르다는 뜻으로, 누구는 쓰기 편하다는 뜻으로 이해합니다. 그래서 품질을 몇 가지 특성으로 나눠 같은 잣대로 말할 수 있게 국제 표준이 만들어졌습니다. 매뉴얼에 제품의 품질 특성을 밝히거나, 제품을 평가하고 인증받을 때 이 표준의 이름을 씁니다.

시험에서 중요한 표준은 ISO/IEC 9126과 그 뒤를 잇는 ISO/IEC 25010입니다. 9126은 오랫동안 소프트웨어 품질 특성의 기준으로 쓰였고, 이후 품질 관련 표준들을 하나로 모은 ISO/IEC 25000 시리즈(SQuaRE)가 만들어지면서 품질 모델은 25010으로 넘어갔습니다.

ISO/IEC 9126: 여섯 가지 품질 특성

ISO/IEC 9126은 소프트웨어 품질을 여섯 가지 특성으로 나눕니다. 기능성은 사용자가 요구한 기능을 정확히 제공하는지를 봅니다. 기능이 목적에 맞는지(적합성), 결과가 정확한지(정확성), 다른 시스템과 함께 동작하는지(상호운용성), 허가되지 않은 접근을 막는지(보안성)가 여기 들어갑니다. 9126에서는 보안성이 기능성 아래의 하위 특성이라는 점을 기억해 두세요.

신뢰성은 정해진 조건에서 기능을 오래, 안정적으로 유지하는 능력입니다. 고장이 잘 나지 않는 성숙성, 고장이 나도 기능을 이어 가는 고장 허용성, 고장 뒤 원래 상태로 돌아오는 회복성이 하위 특성입니다. 사용성은 사용자가 쉽게 이해하고(이해성), 배우고(학습성), 조작하는지(운용성), 그리고 사용자에게 매력적으로 느껴지는지(친밀성, 매력성이라고도 함)를 봅니다. 효율성은 주어진 자원으로 얼마나 빠르게 처리하는지(시간 효율성, 시간 반응성이라고도 함)와 자원을 얼마나 적게 쓰는지(자원 효율성, 자원 활용성이라고도 함)를 봅니다.

유지보수성은 고쳐야 할 때 얼마나 수월한지입니다. 문제 원인을 찾기 쉬운 분석성, 고치기 쉬운 변경성, 고친 뒤 예상치 못한 부작용이 적은 안정성, 고친 것을 확인하기 쉬운 시험성이 있습니다. 이식성은 다른 환경으로 옮겨 가는 능력으로, 새 환경에 맞추는 적응성, 쉽게 설치되는 설치성, 다른 소프트웨어와 함께 지내는 공존성, 기존 제품을 대신할 수 있는 대체성이 있습니다. 기능이 맞고(기능성), 안 멈추고(신뢰성), 쓰기 쉽고(사용성), 빠르고(효율성), 고치기 쉽고(유지보수성), 옮기기 쉬운가(이식성)로 묶어 기억하면 됩니다.

ISO/IEC 25010: 여덟 가지로 넓어진 품질 특성

ISO/IEC 25010(2011)은 9126의 틀을 이어받으면서 특성을 여덟 가지로 정리했습니다. 기능 적합성, 성능 효율성, 호환성, 사용성, 신뢰성, 보안성, 유지보수성, 이식성입니다. 이름만 보면 비슷하지만 달라진 점이 있습니다.

가장 큰 변화는 보안성과 호환성이 독립된 특성으로 올라선 것입니다. 9126에서 기능성 안에 있던 보안성이 따로 나왔고, 다른 시스템과 정보를 주고받거나 같은 환경에서 함께 동작하는 능력이 호환성으로 묶였습니다. 기능성은 기능 적합성으로, 효율성은 성능 효율성으로 이름이 바뀌었습니다. 하위 특성도 일부 손질되어, 예를 들어 유지보수성에는 모듈성과 재사용성이 들어가고 분석성·변경성·시험성은 이어집니다.

참고로 25010은 2023년에 다시 개정되어 사용성이 상호작용 능력으로, 이식성이 유연성으로 이름이 바뀌고 안전성이 새 특성으로 추가되는 등 일부가 달라졌습니다. 다만 출제는 주로 2011판의 여덟 가지 이름을 기준으로 하므로, 위의 여덟 가지를 정확히 외워 두면 됩니다.

품질 특성은 매뉴얼과도 이어집니다. 설치 매뉴얼이 친절하면 이식성의 설치성을 돕고, 사용자 매뉴얼이 잘 정리되어 있으면 사용성의 학습성과 이해성이 높아집니다. 매뉴얼은 제품 밖의 부록이 아니라 품질의 일부라는 뜻입니다.

실무에서는 이렇게 쓰여요

문의가 줄어든 설치 매뉴얼

출시 첫 주에 '설치 후 실행이 안 된다'는 문의가 몰렸습니다. 살펴보니 사용자들이 사전에 설치해야 할 구성 요소를 건너뛰고 있었습니다. 설치 매뉴얼 맨 앞에 '설치 전 확인' 절을 두고 확인 방법을 화면과 함께 넣자 같은 문의가 크게 줄었습니다.

같은 요구, 다른 품질 특성

'접속자가 몰려도 3초 안에 응답해야 한다'는 요구는 25010의 성능 효율성에, '서버 하나가 죽어도 서비스가 계속되어야 한다'는 신뢰성에, '권한 없는 사람이 남의 주문을 볼 수 없어야 한다'는 보안성에 해당합니다. 마지막 요구를 9126으로 분류하면 기능성 아래의 보안성이 됩니다.

총정리 목차로