MEMO Collaborator Tutorial
리뷰참여자들은 Collaborator 를사용함으로써 각자의역할과책임을이해및분담하고리뷰프로세스를객관화 및체계화하여고품질의결과물을산출할수있습니다.
목 차 도 구 실 I II III Collaborator 준비 Collaborator 다운로드 Server 설치 Client 설치 Server 및 Client 설정 Server 주소, 사용자계정추가및그룹설정 Email 및사용자정의필드설정 Client 설정및 SCM 연동 리뷰생성 참여자역할설정체크리스트설정리뷰템플릿설정리뷰생성 습 IV 리뷰진행 (Formal Inspection) PLANNING ANNOTATING INSPECTION REWORK COMPLETED
[ ] Collaborator 준비 Collaborator 다운로드 Server 설치 Client 설치
Collaborator 다운로드 (1/2) 도구준비 Collaborator 설치를위해서는 JRE 가설치되어있어야합니다. 내 PC 에 JRE 가설치되어있지않다면아 래주소로접속하여 JRE 를다운로드해주세요. - http://java.com/ko/download/
Collaborator 다운로드 (2/2) 도구준비 아래주소로접속하여 Collaborator Server 와 Client 를다운로드합니다. - http://support.smartbear.com/downloads/collaborator/installers-for-collaborator-9
[ ] Collaborator 준비 Collaborator 다운로드 Server 설치 Client 설치
Server 설치 (1/5) 도구준비 Server 설치파일을실행하여각단계에서 Next 를클릭합니다. - Server Setup Wizard - License Agreement - Select Destination Directory 1 2 3
Server 설치 (2/5) 도구준비 - Choose Installation Type - Select Start Menu Folder - Completing Server Setup 4 5 6
Server 설치 (3/5) 도구준비 설치가끝나면데이터베이스초기화페이지가나타납니다. INITIALIZE DATABASE 를클릭해주세요. 초기화진행이완료되면로그인페이지가나타납니다. admin 으로접속하여관리페이지로진입합니다. - ID : admin / PW : 필요없음 - admin ID 는리뷰사용이불가능한계정입니다.
Server 설치 (4/5) 도구준비 admin ID 로 Login 하면관리책임자설정과사용자계정등록페이지가나타납니다. 관리책임자설정 부분에서는 Collaborator 를선택하고책임자정보를입력합니다. 사용자계정등록페이지에서는적어도 두명이상실제사용자계정을등록해주세요.
Server 설치 (5/5) 도구준비 정상적으로설치가되었다면라이선스코드가출력됩니다. 설치후꼭라이선스코드를확인해주세요.
[ ] Collaborator 준비 Collaborator 다운로드 Server 설치 Client 설치
Client 설치 (1/4) 도구준비 Client 설치파일을실행하여각단계에서 Next 를클릭합니다. - Client Setup Wizard - License Agreement - Select Destination Directory 1 2 3
Client 설치 (2/4) 도구준비 - Select Start Menu Folder - Server Connection Server URL 주소입력 사용할 ID와 PW 입력 4 5
Client 설치 (3/4) 도구준비 Server 설치또는사용자계정생성이안되어있거나비정상적인 Server 주소를입력했다면 I/O Error 가 발생할수있습니다. 정보입력은설치완료후진행해도무방합니다. 이단계를스킵하시려면 Continue 버튼을클릭하여다음단계로이동합니다.
Client 설치 (4/4) 도구준비 - Select Additional Tasks - Completing Client Setup 6 7
[ ] Server 및 Client 설정 Server 주소설정사용자계정추가, 상세정보및그룹설정 Email 설정사용자정의필드설정 Client 설정 SCM 연동
Server 주소설정 Server 및 Client 설정 메인상단의 Admin 을클릭하여관리페이지로이동합니다. General의 System에서외부 Client PC가 Server에접근이가능하도록 URL 주소를변경해주세요. 주소변경후 TEST 버튼을클릭하여 Server 메인페이지가정상출력되는지확인합니다. 정상출력이되었다면 SAVE 버튼을클릭하여변경주소를저장합니다.
[ ] Server 및 Client 설정 Server 주소설정사용자계정추가, 상세정보및그룹설정 Email 설정사용자정의필드설정 Client 설정 SCM 연동
사용자계정추가및상세정보설정 (1/5) Server 및 Client 설정 관리페이지의 Users 에서사용자계정을생성할수있습니다. 생성된계정은하단의 User List 에출력됩 니다. 생성된계정의상세정보를수정하고싶다면해당계정의 [Edit] 를클릭해주세요.
사용자계정추가및상세정보설정 (2/5) Server 및 Client 설정 사용자정보수정페이지에서정보수정뿐만아니라해당사용자의상세정보를확인할수있고관리자 권한도부여할수있습니다.
사용자계정추가및상세정보설정 (3/5) Server 및 Client 설정 알림설정을통해관리자나다른사용자의활동사항에대한알림의등급을조절할수있습니다.
사용자계정추가및상세정보설정 (4/5) Server 및 Client 설정 Display 설정부분에서사용자는자신의사용환경에맞게각항목들을설정할수있습니다. 사용자인터페이스를이해할수있도록 Tutorial 모드를활성화할수있고리뷰요약페이지의화면스타일과리뷰대상이될파일을겹치거나분리할수있으며 Changelist내에서표시되는파일의스타일을압축, 트리형태로표현할수있습니다.
사용자계정추가및상세정보설정 (5/5) Server 및 Client 설정 Review Subscriptions 를통해선호하는 Author 를선택하여자신의역할을지정함으로써선택한저자의 리뷰에자동으로참여할수있습니다. 또한선호하는특정파일이있다면 File Subscriptions 를통해 Collaborator 에서제공하는패턴을사용 해해당파일이대상인리뷰에자동으로참여할수있습니다.
그룹설정 (1/2) Server 및 Client 설정 그룹설정을통해보다쉽게리뷰참여자들을선택할수있습니다. 프로젝트의상황과환경을기반으로 그룹을설정한다면보다편리하고효율적으로리뷰가관리될것입니다.
그룹설정 (2/2) Server 및 Client 설정 - Edit Group Description Associate with Reviews = 내그룹의리뷰참여여부설정 Review Pool Participant Status - Group Administrators of this Group 그룹의관리자추가 - Child Groups of this Group - Users that are members of this Group 해당그룹의멤버추가
[ ] Server 및 Client 설정 Server 주소설정사용자계정추가, 상세정보및그룹설정 Email 설정사용자정의필드설정 Client 설정 SCM 연동
Email 설정 Server 및 Client 설정 Email 설정을통해리뷰초대, 리뷰상태변경을포함한모든활동사항을 Email 을통해공지합니다. SMTP 정보를포함한각항목을입력하고 SAVE 버튼을클릭하여 TEST 메일을발송해주세요.
[ ] Server 및 Client 설정 Server 주소설정사용자계정추가, 상세정보및그룹설정 Email 설정사용자정의필드설정 Client 설정 SCM 연동
사용자정의필드설정 (1/4) Server 및 Client 설정 Review Custom Fields 에서새로운필드를생성하거나기존필드를변경하면리뷰의개요부분에적용 됩니다.
사용자정의필드설정 (2/4) Server 및 Client 설정 Participant Custom Field 를사용하면리뷰의각참가자에대해서로다른값을갖는추가필드를구성 할수있습니다.
사용자정의필드설정 (3/4) Server 및 Client 설정 Defect Custom Fields 에서새로운필드를생성하여보다상세하게결함을등록할수있습니다.
사용자정의필드설정 (4/4) Server 및 Client 설정 생성한필드는 Review Templates 에서적용할수있습니다.
[ ] Server 및 Client 설정 Server 주소설정사용자계정추가, 상세정보및그룹설정 Email 설정사용자정의필드설정 Client 설정 SCM 연동
Client 설정 (1/3) Server 및 Client 설정 Client 를통해 SCM 연동과리뷰를생성할수있으며참여중인리뷰와역할, 진행상태확인이가능합니다. 만약 Client 설치중에 Server 주소와사용자계정등록을 Skip 했다면 Preferences 의 Server Connection 에서다시등록해주세요.
Client 설정 (2/3) Server 및 Client 설정 - External Diff Launcher Diff ( 파일비교유틸 ) 선택
Client 설정 (3/3) Server 및 Client 설정 - Misc Refresh interval 설정 Browser 설정
[ ] Server 및 Client 설정 Server 주소설정사용자계정추가, 상세정보및그룹설정 Email 설정사용자정의필드설정 Client 설정 SCM 연동
SCM 연동 (1/4) Server 및 Client 설정 11가지의 SCM 연동으로보다효과적인코드버전관리와리뷰를진행할수있습니다. Server에접속하여번거롭게대상파일을등록하지않아도됩니다. Client를통해쉽고빠르게 Revision된파일을불러올수있습니다. - Supported SCMs for Code Review AccuRev Mercurial CVS Microsoft Team Foundation Server (TFS) Git MKS - PTC Integrity IBM Rational ClearCase Perforce IBM Rational Synergy Subversion IBM Rational Team Concert (RTC)
SCM 연동 (2/4) Server 및 Client 설정 Subversion 연동의예 - Subversion Client 설치 Tortoise SVN Download > http://tortoisesvn.net/downloads.html 설치시주의사항 > svn.exe 경로선택필수! - Subversion Server 설치 VisualSVN Server Download > https://www.visualsvn.com/ - SVN Client 설치시 svn.exe 경로선택 - - SVN Client 다운로드페이지 - - SVN Server 다운로드페이지
SCM 연동 (3/4) Server 및 Client 설정 SCM Add ( 내 PC에설치된 Subversion 정보입력 ) - Local Source Code Location Add Changes 사용에필요 - SCM Specific Options SVN exe 파일경로입력 Repository URL 주소입력 SVN Server 사용자계정, 암호입력
SCM 연동 (4/4) Server 및 Client 설정 Validate - SCM 연동의성공, 실패여부를 Result Configuration 에서확인 - 성공 - - 실패 -
[ ] 리뷰생성 참여자역할설정체크리스트설정리뷰템플릿설정리뷰생성
참여자역할설정 (1/4) 리뷰프로젝트생성 리뷰는역할과책임이명확하지않고절차를준수하지않는다면성공적인성과를내기어렵습니다. Collaborator 는참여자요구사항 ( 자격조건 ) 과역할분담, 리뷰단계를구성하고제어하여프로세스를 객관화하고체계화함으로써성공적인리뷰가될수있도록지원합니다.
참여자역할설정 (2/4) 리뷰프로젝트생성 Formal Inspection - Moderator 리뷰의흐름제어및참여자들의업무보장 다양한관점에서리뷰를제어 - Author 리뷰대상산출물의작성자또는책임자 - Tester (Reviewer) 리뷰대상에서인시던트 ( 결함포함 ) 를발견하고기술 용이성, 추적성, 요구사항및표준등을고려하여리뷰를수행 - Reader 리뷰의실행여부를결정, 수행된리뷰의내용을표명 리뷰의목적달성여부를확인하고승인
참여자역할설정 (3/4) 리뷰프로젝트생성 Standard - Author 리뷰대상산출물의작성자또는책임자 - Reviewer 리뷰대상에서인시던트 ( 결함포함 ) 를발견하고기술 용이성, 추적성, 요구사항및표준등을고려 - Observer 리뷰의관찰자 리뷰단계의확인및승인절차 X
참여자역할설정 (4/4) 리뷰프로젝트생성 내프로젝트의상황과환경을고려하여참여자역할과리뷰절차를새롭게구성할수있습니다.
[ ] 리뷰생성 참여자역할설정체크리스트설정리뷰템플릿설정리뷰생성
체크리스트설정 리뷰프로젝트생성 좀더효과적이고효율적인리뷰를위해다양한관점이반영된체크리스트를설정해주세요.
[ ] 리뷰생성 참여자역할설정체크리스트설정리뷰템플릿설정리뷰생성
리뷰템플릿설정 (1/2) 리뷰프로젝트생성 Review Templates 에서사용자정의필드와참여자역할, 체크리스트사용및리뷰의반려사유를 설정하여내리뷰에맞는 Template 을생성해주세요.
리뷰템플릿설정 (2/2) 리뷰프로젝트생성 반려사유설정 - General 페이지하단 > Review Reject Reasons
[ ] 리뷰생성 참여자역할설정체크리스트설정리뷰템플릿설정리뷰생성
리뷰생성 (1/3) 리뷰프로젝트생성 Server 에접속하여리뷰를생성할수있습니다. 만약 SCM 도구를사용한다면 Client 를통해쉽고편리한 리뷰생성을권장합니다.
리뷰생성 (2/3) 리뷰프로젝트생성 Add Revisions - 새로운리뷰생성혹은기존리뷰프로젝트선택 - Revisions ID 입력 - 지원문서선택
리뷰생성 (3/3) 리뷰프로젝트생성 - 리뷰생성요약 - 서버로전송 - 리뷰설정페이지로이동
[ ] 리뷰프로세스진행 (Formal Inspection) PLANNING ANNOTATING INSPECTION REWORK COMPLETED PLANNING ANNOTATING INSPECTION REWORK COMPLETED
PLANNING (1/4) 리뷰프로세스진행 리뷰요약페이지에서는리뷰개요작성, 참여자선택및리뷰대상파일을등록합니다. 리뷰가진행이되면 등록된결함과채팅로그, 리뷰단계를이페이지에서확인할수있습니다.
PLANNING (2/4) 리뷰프로세스진행 - Review #??: Title 리뷰제목과그룹설정 리뷰에적용할템플릿선택 접근제한설정 리뷰개요 DONE EDITING 클릭
PLANNING (3/4) 리뷰프로세스진행 - Participants 내역할선택 그룹혹은각참여자선택후역할적용 Poke를사용해참여자들에게알림 ( 예 : Email 발송 ) Participant Custom Fields를생성하였다면생성의도에맞게설정
PLANNING (4/4) 리뷰프로세스진행 Server Home 의리뷰항목또는 Poke 를사용하여보낸 Email 의링크를통해참여자들은해당리뷰에자 신이초대됨을확인할수있습니다. - Server Home - - Poke mail -
[ ] 리뷰프로세스진행 (Formal Inspection) PLANNING ANNOTATING INSPECTION REWORK COMPLETED PLANNING ANNOTATING INSPECTION REWORK COMPLETED
ANNOTATING 리뷰프로세스진행 PLANNING 단계가마무리되면화면하단의 ANNOTATE REVIEW 를클릭하여다음단계로넘어갑니다. 리뷰가시작되기전, 이단계에서는 Moderator와 Author가리뷰시작에대한의견을나누고리뷰대상파일을추가합니다. 만약 Client를통한리뷰생성시리뷰파일을불러왔다면이미그파일이등록되었을것입니다.
[ ] 리뷰프로세스진행 (Formal Inspection) PLANNING ANNOTATING INSPECTION REWORK COMPLETED PLANNING ANNOTATING INSPECTION REWORK COMPLETED
INSPECTION (1/4) 리뷰프로세스진행 ANNOTATING 이끝나면 Moderator 나 Author 는 BEGIN REVIEW 를클릭하여 INSPECTION 단계로변 경합니다. Server 에업로드된리뷰대상파일을클릭하여리뷰페이지로이동합니다.
INSPECTION (2/4) 리뷰프로세스진행 리뷰페이지에서 Reviewer를포함한참여자들은해당파일을조사합니다. - Code Review 수정대상라인선택 > 화면왼쪽결함입력란에결함내용입력 > ADD AS DEFECT 클릭 > 결함심각도와유형을선택후 ADD DEFECT 클릭
INSPECTION (3/4) 리뷰프로세스진행 - Document Review 수정대상부분 ( 좌표 ) 선택 > 화면왼쪽결함입력란에결함내용입력 > ADD AS DEFECT 클릭 > 결함심각도와유형을선택후 ADD DEFECT 클릭
INSPECTION (4/4) 리뷰프로세스진행 리뷰페이지상단의 Display 를클릭하여내화면보기및필터, 텍스트설정이가능합니다.
[ ] 리뷰프로세스진행 (Formal Inspection) PLANNING ANNOTATING INSPECTION REWORK COMPLETED PLANNING ANNOTATING INSPECTION REWORK COMPLETED
REWORK (1/9) 리뷰프로세스진행 INSPECTION 이끝나면 Moderator 는 SEND TO REWORK 를클릭하여 REWORK 단계로변경합니다. Author 는 Defect Log 나대상파일을클릭하여리뷰페이지에진입합니다. 이후참여자들의조사내용을 확인합니다.
REWORK (2/9) 리뷰프로세스진행 해당문서의결함내용을참고하여리뷰대상파일을수정합니다. - 리뷰대상파일다운로드 - - 파일수정 -
REWORK (3/9) 리뷰프로세스진행 화면상단의 External 과 Download Diff 기능을통해보다편리하게파일을수정할수있습니다. - SourceGear DiffMerge - - TortoiseUDiff-
REWORK (4/9) 리뷰프로세스진행 수정내용이반영된파일을 Server 에서직접또는 SCM 과연동된 Client 를통해등록합니다. - Server( 리뷰요약페이지 ) 에서수정파일업로드 - - Client 에서수정파일업로드 -
REWORK (5/9) 리뷰프로세스진행 수정전후파일을비교하기위해서는해당파일들의이름이동일해야합니다. 이규칙을준수하여수정된 파일이등록되면 Review Materials 의 Status 가 Count 됨을확인할수있습니다.
REWORK (6/9) 리뷰프로세스진행 Author 는리뷰페이지에진입하여자신이등록한수정파일이정상적으로수정되었는지이전파일과비교 합니다. 이부분도 External 과 Download Diff 기능을통해보다편리하게파일을비교할수있습니다.
REWORK (7/9) 리뷰프로세스진행 Author 는수정내용의검토가완료되면리뷰요약페이지하단의 SEND TO INSPECTION 을클릭하여 리뷰를 INSPECTION 단계로변경합니다. Author 를제외한참여자들은자신들이발견한결함이수정이되었는지확인하기위해다시리뷰페이지 로진입합니다.
REWORK (8/9) 리뷰프로세스진행 해결된결함은 Close 하고미해결된결함은 Comment 를통해참여자들에게알리는수정확인활동을 포함한재조사를진행합니다.
REWORK (9/9) 리뷰프로세스진행 재조사를진행하여기존결함이수정되지않았거나새로운결함을발견하게되면 Moderator 는리뷰단 계를 Rework 로변경하여 Author 에게결함이아직존재함을알려줍니다. INSPECTION 과 REWORK 의 반복적인단계를통해결함을점차줄여나감으로써리뷰대상산출물의품질을높여나갑니다.
[ ] 리뷰프로세스진행 (Formal Inspection) PLANNING ANNOTATING INSPECTION REWORK COMPLETED PLANNING ANNOTATING INSPECTION REWORK COMPLETED
COMPLETED (1/3) 리뷰프로세스진행 결함조치가 100% 완료되고더이상결함이존재하지않다고판단하면 Moderator 는 COMPLETED 로 리뷰단계를변경합니다. 만약재조사필요하면 REOPEN 권한이있는참여자를통해 INSPECTION 단계로변경할수있습니다. 또한해당리뷰가반려의대상이라면 REJECT 권한이있는참여자를통해반려할수있습니다.
COMPLETED (2/3) 리뷰프로세스진행 해당리뷰의자세한내역을확인하고자한다면 DETAIL 을클릭하여 Review Detail Report 페이지로진 입해주세요.
COMPLETED (3/3) 리뷰프로세스진행 Collaborator 는다양한범위의 Report 를제공합니다. Reports 페이지의각카테고리에서검색과설정 으로상세한 Report 기능을활용할수있으며 CSV, PDF, EXCEL 파일로 Export 가가능합니다.
MEMO 제품및구입문의 SMARTBEAR Authorized reseller 자동화솔루션사업팀 / 컨설팅사업본부 전화 070-7864-7721 대표이메일 stas@sta.co.kr