|
|
 |
|
| 훌륭한 프로젝트 리포트 작성법 |
| |
| [ 노규남(IT 테크라이터) 2005/11/07] |
| |
이번에 알아볼 내용은 VSTS의 리포트 기능이다. 프로젝트를 진행하다보면 보고서를 작성해야 하는 경우가 많이 있다. 프로젝트가 언제 결과물이 나오는가 하는 간단한 것부터 발견된 버그가 얼마나 빨리 수정되는가, 각 개발자의 생산성은 어떠한가, 하는 다소 복잡한 내용까지, 위에 있는 사람들은 끝없이 보고서를 받아보고 싶어한다. 회사에 따라 다르지만 개발자들이 가장 싫어하는 작업이 이런 끝없는 paperwork이라고 할 정도로 개발에 따르는 문서작성은 프로젝트를 지연시키는 주된 요소중의 하나이다.
하지만 VSTS를 사용하면 단순히 소스를 check in하고, Work Item을 처리하고, 버그를 보고하는 등의 일상적이고 필수적인 작업만 충실히 수행한다면 윗분들에게 제출할 보고서는 자동으로 만들 수 있다. 이는 TFS가 프로젝트에 대한 모든 변경과 Activity를 자체 데이터웨어하우스에 저장하기 때문이다.
TFS는 데이타웨어하우스이다
앞서 TFS의 설치과정에 대해서 설명한 적이 있는데 이 과정중의 하나로 SQL Server 2005가 포함되어 있음을 기억할 것이다. TFS는 SQL Server 2005를 기본 데이터웨어하우스로 사용하고 있으며 여기에는 소스나 Work Item같은 프로젝트를 진행하는데 있어서 가장 기본이 되는 데이터들부터 시작해서 테스트 결과, 성능측정 결과, 빌드 결과 등등 TFS를 사용하면서 발생하는 모든 종류의 자료들을 전부 저장한다.
한마디로 과장없이 TFS를 거치는 모든 작업은 다 기록된다고 보면 된다. 단순히 소스나 Work Item을 저장하고 나중에 꺼내보려는 목적으로 데이터베이스를 쓰는 것이 아니라 수집된 데이터로부터 이후 프로젝트의 관리에 유용한 분석결과를 얻어내려는 것이기 때문에 성능좋은 데이터베이스인 SQL Server 2005를 필요로 하고 있다.
개발자는 소스를 check in하고, Work Item을 수정하며, 테스트를 만드는 등 개발에 필요한 작업을 일정에 따라 수행하기만 하면 그 내용은 모두 기록되어 리포트를 만드는데 사용될 수 있게 된다는 것이다. 리포트를 작성하는 것도 주어진 양식이 이미 있으므로 이에 맞춰 자료의 기간과 조건만 지정하면 자동적으로 만들어준다. 출력하고 싶다면 바로 출력해도 되며, PDF나 Excel, TIFF 이미지등 다양한 형식으로 변환가능하므로 어떤 형태를 원하더라도 대응가능하다.
이렇게 일일이 보고서를 작성해서 전달하는 것이 번거롭다면 상사에게 Report Site를 알려주고, 여기에 접속해서 직접 보고서를 받으라고 할 수도 있다. 아무리 컴퓨터에 익숙하지 않은 상사라도 웹서핑은 할 수 있지 않겠는가. 상사 입장에서도 웹서핑만 할 수 있다면 부하직원에게 보고서를 가져오라고 지시하고 기다렸다가 받아서 검토할 필요없이 언제나 최신버전의 보고서를 받아볼 수 있으며, 그에 근거해서 의사판단을 하는 기민한 대응이 가능해지는 것이다.
디폴트 리포트
역시 직접 다루어보는 것 이상 이해를 빠르게 하는 방법은 없으니 바로 리포트를 작성해보자. 프로젝트를 만들게 되면 기본적으로 리포트 폴더가 만들어지는데 여기에는 새 프로젝트를 시작할 때 기본적으로 주어지는 리포트 폼들이 저장되어 있다. 사용자는 저장된 데이터로부터 원하는 형태의 리포트를 언제든지 뽑아낼 수 있으며 그를 위해 커스터마이즈한 양식을 정의할 수도 있지만 여기에 저장된 양식들은 가장 많이 사용되는 종류들이므로 대부분의 프로젝트에서 이들만으로도 충분히 보고가 가능하다. 기본적으로 제공되는 양식은 버그리스트, 빌드현황, 남은 작업, 테스트 상세결과 등등 실제 프로젝트의 진행에 도움을 줄 수 있는 것들이다.
이들 중 하나를 더블클릭하면 TFS의 백엔드인 SQL Server 2005에 저장된 데이터를 이용해 해당하는 리포트가 자동으로 만들어지고 화면에 나타나게 된다. 만들어진 리포트는 상단의 메뉴를 이용해 CSV, Excel, PDF, TIFF이미지, XML등 다양한 형식으로 Export할 수 있으며 바로 프린트할 수도 있다. 또한 상단 메뉴에서 조건을 주어서 리포트에 적용할 데이터를 제한하거나 리포트의 크기를 조절하는 작업도 가능하다.
 | | 전체 Work Item List를 리포트로 출력한 것이다. |
 |  | | 리포트의 형태는 양식을 정의하기 나름이다. |
Report Site
앞서 본 리포트들은 모두 SQL Server의 Reporting Service를 사용하여 만들어지는 것으로, TFS의 웹사이트와 연동되어 있다. 따라서 만약 리포트만 받아보기를 원한다면 굳이 TFS Domain에 로그인하고 VSTS를 실행시키는 복잡한 과정을 거칠 필요없이 바로 이 웹사이트에 접속하면 된다.
이 사이트는 VSTS를 실행한 상태에서 Reports폴더의 context menu 중 'Show Report Site'를 선택하거나 또는 웹브라우저로 접근하려면 URL로 ‘http://TFS주소/Reports/Pages/Folder.aspx?ItemPath=/프로젝트명’을 바로 입력해도 된다. 이 사이트를 알고 있고 적절한 로그인 권한이 주어진다면 굳이 클라이언트에 VS를 설치하지 않아도 필요한 보고서를 언제든 출력해볼 수 있다. 개발자가 아닌 멤버들이 프로젝트에 대한 자료를 얻으려고 할때 유용하다.
아니면 ‘http://TFS주소/Reports/Pages/Folder.aspx’로 접속하여 Reporting Services의 Home Site에 접근할 수도 있는데, 이 페이지에는 현재 TFS에 존재하는 프로젝트들이 모두 출력되므로 이 프로젝트중 하나를 선택해서 들어가도 같은 결과를 얻을 수 있다.
 | | 리포트 사이트. VSTS에서 보는 것과 완전히 똑같은 아이템들을 보여준다. |
Report Builder
새 프로젝트를 만들때 주어지는 기본 리포트 양식들은 매우 적절하며 훌륭하다. 그러나 때로는 프로젝트의 특수한 상황 때문에 커스터마이즈한 양식이 필요할 때가 있다. 이런 경우 에 Report Builder를 사용하면 리포트 폴더에 자신이 원하는 새 양식을 추가할 수 있다.
Report Builder는 Report Site의 상단메뉴를 선택해서 실행되는 ClickOnce 어플리케이션으로 사실 이것은 TFS의 어플리케이션이 아니라 SQL Server 2005에서 제공하는 서비스이다. TFS자체가 별도의 리포트 기능을 구현하지 않고 SQL Server 2005의 Reporting Service를 쓰기 때문에 SQL Server 2005에와 똑같이 활용할 수 있다.
Reporting은 SQL Server 2005의 핵심기능중 하나로 SQL Server 2005가 단순한 DBMS가 아니라 데이터웨어하우스, 즉 수집된 데이터를 근거로 사용자가 의사판단할 수 있는 가공된 데이터를 제공할 수 있는 솔루션임을 증명하는 기능이다.
Report Builder는 이런 SQL Server의 리포팅 기능을 지원하는 리포트폼을 만들어주는 프로그램으로 아무래도 간단한 종류이므로 table이나 matrix, chart의 몇가지 정형적인 골격안에서 간단히 편집할 수 있도록 되어 있다. 만약 좀더 자유롭게 리포트 양식을 작성하고 싶다면 Visual Studio의 Report Designer나 서드파티의 툴들을 사용해도 된다. 어떤 종류의 툴이라도 RDL(Report Definition Language)를 지원하는 포맷으로 만들기만 하면 OK이다.
이렇게 해서 작성된 리포트 양식은 적절한 권한을 갖고 있다면 Reporting Site에 업로드할 수 있으며, 이후로는 TFS의 데이터웨어하우스에 저장된 데이터로부터 이 양식에 근거한 보고서를 생성할 수 있다.
 | | 리포트 빌더 |
마치며
TFS의 리포트 기능은 모든 개발자가 달가와하지 않는 보고서 작성을 도와주는 아주 유용한 도구이므로 향후 활용도가 매우 높아보인다. 단순히 제출용의 리포트를 만들어준다는 것에 그치지 않고 언제든지 원하는때 실시간으로 현재 프로젝트에 대한 상태를 여러 가지 형태의 리포트로 받아볼 수 있다. 그러므로 실제 작업이 어떻게 진행되고 있는지에 대해 좀더 직관적으로 접근할 수 있으며, 이를 통해 더 프로젝트를 효율적으로 관리할 수 있다.
다만 아직까지 한글화가 되어 있지 않은 점은 아쉬운데 정식버전이 출시될 때 이 부분은 당연히 수정되어서 나오리라 기대해본다. 아주 많은 기대가 되는 VSTS의 기능중 하나이다.
필자 노규남님은 게임개발에 주력하고 있으며, 오랫동안 각종 플랫폼에서 사용되는 개발도구를 사용한 경험이 풍부하다. |
 |
|
|
 |
 |
|
|
|
