제품 소프트웨어 매뉴얼 작성 & 제품 소프트웨어 버전 등록

1. 제품 소프트웨어 매뉴얼

제품 소프트웨어 매뉴얼

제품 소프트웨어 개발단계부터 적용한 기준이나 패키징이후 설치 및 사용자 측면의 주요 내용 등을 문서로 기록한 것

사용자 중심의 기능 및 방법을 나타낸 설명서와 안내서

 

설치 매뉴얼 작성의 기본 사항

(1) 설치 매뉴얼은 개발자의 기준이 아닌 사용자의 기준으로 작성

(2) 최초 설치 실행부터 완료까지 순차적으로 진행

(3) 각 단계별 메시지 및 해당 화면을 순서대로 전부 캡처하여 설명

(4) 설치 중간에 이상 발생 시 해당 메시지 및 에러에 대한 내용을 분류하여 설명

 

제품 소프트웨어 설치 매뉴열의 기본 작성 항목

기본 작성 항목		설명
목차 및 개요	목차	매뉴얼 전체의 내용을 순서대로 요약
서문	개요	설치 매뉴얼의 주요 특징에 대해 정리 설치 매뉴얼에서의 구성과 설치 방법, 순서 등에 대해 기술
	문서 이력 정보
	설치 매뉴얼의 주석	주의 사항: 사용자가 제품 설치 시 반드시 숙지해야 하는 중요한 정보 주석 표시 참고 사항: 설치 관련하여 영향을 미치는 특별한 사용자 환경 및 상황에 대한 내용 주석 표시
	설치 도구의 구성	프로그램 파일 구성(설치 파일 및 폴더) exe / dll / ini / chm 등 해당 설치 관련 파일 설명 폴더 및 설치 프로그램 파일 설명 설치 이후에 설치 결과를 기록하는 Log 폴더 설명 설치 위치, 다음장의 환경 체크 항목들 공지

 

제품 소프트웨어 설치 환경 체크 항목

확인 항목	체크할 내용
사용자 환경	사용자의 CPU 및 Memory, OS 등의 적합 환경 확인
응용 프로그램	설치 전 다른 응용 프로그램의 종료 확인
업그레이드 버전	업그레이드 이전 버전에 대한 존재 유무 확인
백업 폴더 확인	데이터 저장 폴더를 확인하여 설치 시 폴더 동기화

 

제품 소프트웨어 설치 매뉴얼의 기본 작성 항목

기본 작성 항목		설명
기본 사항	제품 소프트웨어 개요	제품 소트웨어의 주요 기능 및 UI 설명 UI 및 화면 상의 버튼, 프레임 등을 도식화하여 설명
	설치 관련 파일	제품 소프트웨어를 설치하기 위한 관련 파일 설명 설치 구동을 위한 exe 실행 ini나 log 파일 같은 관련 파
	설치 아이콘	설치 아이콘(Installationn) Windows 구동용 설치 아이콘 설명
	프로그램 삭제	해당 소프트웨어 삭제시 원래대로 삭제하는 방법을 설명
	관련 추가 정보	제품 소프트웨어 이외의 관련 설치 프로그램 정보(Build) 관련 프로그램 제작사 추가 정보 기술

 

제품 소프트웨어 설치 매뉴얼 작성 방법 상세 가이드

항목		항목 설명
① 설치 매뉴얼 내용	설치 화면 및 UI	설치 실행: exe 등의 Intall 파일을 실행하도록 화면 첨부 메인 화면 및 안내창: 이미지로 해당 내용을 직접 첨부하여 설치 시 나타나는 내용 설명
	설치 이상 시 메시지 설명	설치가 잘못되었거나 잘못된 환경일 경우 메시지 설치 단계별 참고사항, 주의 사항 등을 메모로 추가
	설치 완료 및 결과	정상 설치 완료시 최종 메시지 출력 정상 결과 및 사용에 대한 안내를 함으로써 설치가 잘되었음을 최종 통지
	FAQ	제품이 설치되지 않을 때를 대비
	설치 시 점검 사항	설치 전 사용자 환경에 맞추어 점검할 내용들을 설명 사용자 계정 및 설치 권한에 대해 확인할 수 있도록 함 설치 중간에 에러 발생 시 체크할 사항을 설명
	Network 환경 및 보안	설치 시 Network 오류가 발생하지 않도록 사전에 Connection을 체크 보안 및 방화벽 등의 문제로 설치가 안될 경우에 대비해 환경 체크 가이드

 

② 고객 지원 방법(Customer Support)

- 유선 및 E-mail, Website URL

 

③ 준수 정보 & 제한 보증(Compliance Information & Limited Warranty)

- Serial 보존, 불법 등록 사용 금지 등의 준수 사항 권고

- 저작권 정보 관련 작성

 

설치 매뉴얼 수행 순서

 

 

 

 

2. 제품 사용자 매뉴얼

사용자 메뉴얼 작성의 기본 사항

개발이 완료된 제품 소프트웨어를 고객에게 전달하기 위한 형태로 패키징하고

설치와 사용에 필요한 제반 절차 및 환경 등 전체 내용을 포함하는 매뉴얼을 작성하며,

제품 소프트웨어에 대한 패치 개발과 업그레이드를 위해 버전 관리를 수행

개발된 컴포넌트 사용시에 알아야 할 내용을 기술

패키지의 기능, 패키지 인터페이스, 포함하고 있는 메소드나 오퍼레이션과 메소드의 파라미터 등의 설명이 포함

 

사용자 매뉴얼 작성 절차

 

 

 

 

기록 보관

 

제품 소프트웨어 버전 관리

버전 관리

제품 소프트웨어 버전 관리는 SW 개발과 관련하여 코드와 라이브러리, 관련 문서 등 시간의 변화에 따른 변경을 관리하는 전체 활동을 의미

동일한 소스 코드에 대한 여러 번을 관리

팀 단위로 개발 중인 소스 코드나, 설계도 등의 디지털 문서를 관리

문서의 변경 사항들에 숫자나 문자로 이뤄진 "버전"을 부여해서 구분

버전을 통해 변경된 시간, 변경된 사항, 변경 작업을 행한자를 파악할 수 있음

 

버전 관리 항목 (버전 관리에서 자주 사용되는 용어 정리(Terms))

버전 관리 항목	항목 설명
가져오기(Import)	버전 관리되지 않은 로컬 디렉토리 파일을 처음으로 저장소(Repository)에 복사
체크아웃(Check-out)	저장소(Repository) 파일 받기
체크인(Check-in)	저장소(Repository)에 새로운 버전으로 갱신
커밋(Commit)	체크인시 이전 갱신 사항이 있는 경우 충돌(conflict) 알림, diff 도구 이용 수정, Commit 과정 수행
저장소(Repository)	파일의 현재 버전과 변경 이력 정보를 저장하는 저장소

 

 

추가(Add)	개발자가 신규로 어떤 파일을 저장소(Repository)에 추가(Add)
인출(Check-out)	추가되었던 파일을 개발자가 인출(Check-out)
예치(Commit)	개발자가 인출된 파일을 수정한 다음, 저장소에 예치(Commit)하면서 설명을 붙임
동기화(Update)	Commit 작업 이후 새로운 개발자가 자신의 작업 공간을 동기화(Update) 이때 기존 개발자가 추가했던 파일이 전달
차이(Diff)	새로은 개발자가 추가된 파일의 수정 기록(Change Log)을 보면서 기존 개발자가 처음 추가한 파일과 이후 변경된 파일의 차이를 봄(Diff).

 

버전 등록 순서

 

제품 소프트웨어 버전 관리 도구 유형

버전 관리 도구 유형	설명
공유 폴더 방식 (RCS, SCCS)	매일 개발 완료 파일은 약속된 위치의 공유 폴더에 복사 담당자 한 명이 매일 공유 폴더의 파일을 자기 PC로 복사하고 컴파일하여 에러 확인과 정상 동작 여부 확인 정상 동작일 경우 다음날 각 개발자들이 동작 여부 확인
클라이언트/서버 방식(CVS, SVN)	중앙에 버전 관리 시스템이 항시 동작 개발자들의 현재 작업 내용과 이전 작업내용 축적 용이 서로 다른 개발자가 같은 파일을 작업했을 때 경고 출력 GUI 툴을 이용 모니터링 가능
분산 저장소 방식 (Git, Bitkeeper 등)	로컬 저장소와 원격저장소 구조 중앙의 저장소에서 로컬에 복사(clone)한 순간 개발자가 자신만의 로컬 저장소에 생성 개발 완료한 파일 수정 이후 로컬 저장소에 커밋한 이후 다시 원격 저장소에 반영(Push)하는 방식

 

현업에서 쓰이는 다양한 버전 관리 도구별 특징

버전 관리 도구	설명
CVS (Concurrent Versions System)	서버와 클라이언트로 구성되어 다수의 인원이 동시에 범용적인 운영체제로 접근 가능하여 버전 관리를 가능케 함 Client가 이클립스에 내장되어 있음
SVN (Subversion)	GNU의 버전 관리 시스템으로 CVS의 장점은 이어받고 단점은 개선하여 2000년에 발표 사실상 업계 표준
RCS (Revision Control System)	CVS와 달리 소스 파일의 수정을 한 사람만으로 제한하여 다수의 사림이 파일의 수정을 동시에 할 수 없도록 파일을 잠금하는 방식으로 버전 컨트롤을 수행
Bitkeeper	SVN과 비슷한 중앙 통제 방식의 버전 컨트롤 툴로서 대규모 프로젝트에서 빠른 속도를 내도록 개발
Git	기존 리눅스 커널의 버전 컨트롤을 하는 Bitkeeper를 대체하기 위해서 나온 새로운 버전 컨트롤로 현재의 리눅스는 이것을 통해 버전 컨트롤이 되고 있음 Git는 속도에 중점을 둔 분산형 관리 시스템(DVCS)이며, 대형 프로젝트에서 효과적이고 실제로 유용함 Git는 SVN과 다르게 Commit은 로컬 저장소에서 이루어지고 push라는 동작으로 원격 저장소에 반영됨(로컬 저장소에서 작업이 이루어져 매우 빠른 응답을 받을 수 있음.) 또 받을 때도 Pull 또는 Fetch로 서버에서 변경된 내역을 받아 올 수 있음 <주요 특징> 1) Git의 작업 폴도는 모두 전체 기록과 각 기록을 추적할 수 있는 정보를 포함하는 완전한 형태의 저장소 2) 네트워크에 접근하거나 중앙 서버에 의존하지 않음
Clear Case	IBM에서 제작 복수 서버, 복수 클라이언트 구조이며 서버가 부족할 때 필요한 서버를 하나씩 추가하여 확장성을 기할 수 있음

 

버전 관리 도구 사용의 유의점

형상 관리 지치에 의거 버전에 대한 정보를 언제든지 접근할 수 있어야 함

제품 소프트웨어 개발자, 배포자 이외에 불필요한 사용자가 소스를 수정할 수 없도록 함

동일한 프로젝트에 대해서 여러 개발자가 동시에 개발할 수 있어야 함

에러 발생 시 최대한 빠른 시간 내에 복구함

 

버전 관리도구 사용순서

 

버전 관리 도구를 활용한 통하 버전 현황 관리

관리 작업	활용사례
버전 관리, 백업 및 복구	이전 버전으로의 복구 필요시 이전 버전의 기능을 재활용시
동일 버전 공동 작업	동일 버전의 소스 코드를 두 명 이상의 개발자가 수정할 경우 분산환경에서 두 명이상의 개발자가 동일한 버전의 소스를 수정할 경우
여러 버전 솔루션 작업	하나의 솔루션을 기반으로 여러 버전의 제품을 개발할 경우

 

버전 관리 도구 활용 시 자료 백업 정책 및 방법

버전 관리 항목	항목 설명
백업 정책	버전 관리 라이브러리에 대한 백업 파일은 버전 관리 라이브러리가 저장되 Disk와 분리된 Disk에 저장 Disk 백업은 1일 1회(ex. 매일 03시) 실시(단, 월요일은 제외함.) CD 백업은 1주일 1회(ex. 매주 금요일) 실시 실수에 의한 삭제를 예방하기 위해 백업은 최소 D-2일분 이상 보관
백업 방법	변경된 부분만 백업하는 경우(증분 백업) 편리해 보이기는 하나, 복구 시 복잡한 과정을 고쳐야 하고, 증분 백업 파일에 문제가 발생되는 경우 어려움이 생길 수 있으므로 버전 라이브러리의 백업은 빠른 복구를 위해 Full 백업 백업 작업에 대한 임시/신규 요청 또는 중지 요청은 절차에 따라 실시 백업결과는 버전 관리자 주기적으로 점검하여, 그 결과를 버전 관리 정기 보고시 함께 보고

 

버전 관리 도구를 사용한 소스 및 자료 백업

디렉토리를 신규로 만들며 물리적 복사: Repository Backup: Git 자체가 소스 코드 백업용으로 쓰이지만, 2차 백업 개념으로 ./.Git 폴더의 내용 디렉토리를 물리적으로 다른 곳에 보관하여 백업함

버전 관리 도구의 백업 기능 활용: Git bundle: Git Repository의 bundle을 생성하는 process를 통해 백업 자체를 버전 관리 도구에서 자동화하여 백업을 진행해 주는 백업 방법