개발 로그 작성하기.

'개발 로그'라고 해 놓으니 뭔가 거창해 보이지만, 단순히 그날의 작업 내역을 짧게짧게 간단히 기록하는 것을 말하는 나만의(...) 용어다. 그렇다면 왜 개발 로그를 사용해야 하는가?

기억력에는 개발자마다 개인차가 있겠으나 나의 경우엔 줄줄새는 기억력[...]을 소유하고 있다. 보통 소스를 코딩할 때는 간단하게라도 주석을 달아놓는 편이어서 나중에 그 소스를 다시 보게 되면 무슨 작업을 했었는지, 어떤 식으로 소스가 변경됐었는지(물론 한참 고민이야 하겠지만) 기억을 해내겠지만, 만약 웹서버 설정하느라 해당 웹 서버의 관리 패널에서 뭔가 작업을 했었다면... 절대 기억나지 않는다. '어느 탭 근처였는데...' 정도의 기억이라도 나면 좋으련만 웹 서버 관리 패널에 주석을 달 수는 없는 노릇이니...

처음 이런 형태의 로그를 시작한건 사실 위의 이유 때문은 아니었다. 원래는 뭔가를 급하게 처리하고 있는 도중에 다른 사람이 어떤 작업 요청을 한다든가 했을 때, 집중력을 최대한 덜 흩뜨리고(그리고 나중에 까먹지 않기 위해) 그런 내용을 메모한다든가, 현재 작업중이던 것과는 상관없이 쌩뚱맞게 갑자기 떠오른 아이디어를 간단히 메모한다든가, 그런 것을 최대한 빨리 기록한 후 원래 작업으로 돌아가기 위한 수단이었다. 하지만 어느 날 정신차리고 보니 원래 용도 외에도 개발 내역을 간단히 메모하는데도 사용하고 앉아있더라... 뭐 이랬었다는 얘기.

어쨌든 그럼 개발 로그에 뭘 남기는지, 왜 쓰는지, 어떻게 해야 팍팍 쓰는지를 알아보자.

* 개발 로그엔 뭘 기록하는가?

별거 없다. 그냥 메모장을 열고, 다음처럼 기록을 시작한 시간과 함께 메모를 남기면 그만이다 :

오전 9:26 2006-01-20
- DextUpload 인스톨 여부 확인할 것 ; passed
- 서버 세팅 확인 ; passed
; 계정 있는지, 터미널 지원하는지 등
- 테이블 구조 분석
- 업데이트 내용 정리 및 필요한 테이블 변경사항 체크할 것

오후 3:03 2006-01-20
db 커넥션 함수 추가
/db/dbconnect2.asp
로그인시 사용자에 대한 세션 정보 저장하는 코드 추가
/manager/p00_ok.asp
db 연결 문자열 변경
/common/config.asp

'세션 데이터 확인
Response.Write  Get_SessionInfo

오후 4:02 2006-01-20
도형자료 ; tb_xxxxxx 참조
/manager/file_download.asp

사실 이런 작업 내역을 관리하는데에 더 효율적인 툴을 꼽으라면(그리고 장기 프로젝트를 적용할 생각이라면) 단연 엑셀이 제격이다. 날짜/시간 데이터도 지원하고, 정렬/필터 기능도 있으며 각종 그래프에 피벗 테이블에... 활용을 논하자면 더 할 말이 없겠으나-

* 그럼 왜 이런 개발 로그를 쓰나?

위에도 적었듯이, 개발 내역과 관련된 다양한 메모를 최대한 빨리 기록하기 위해서이다.

프로그래머들이 현명한 관리자의 관리를 받으며, 적절한 길이의 일정을 할당받고, 그때그때의 작업 내역을 기록하는 시간도 작업 내역에 포함되며, 하루에 서너번은 광고 전화를 받고 집중력이 흐트러지고 나서도 작업할 시간은 얼마든지 있는 환경에서 프로그램을 짜고 있다면 좋겠지만-

... 나도 저런 회사에서 일하고 싶다. (월급이 동남아노동자 레벨이 아니라면)

갑자기 웹서버가 500 에러를 뱉어내기 시작하면, 예전에 에러를 수정한 소스가 다시 같은 에러를 뱉어내기 시작하면, 클라이언트의 시스템에 프로그램을 설치했는데 아예 동작할 기미도 보이지 않는다면...

이렇게 작성해둔 몇 줄의 메모가 당신을 구하게 될 날은 반드시 온다.

그리고 '네가 대체 한 일이 뭐야!'라고 윽박지르는 상사에게, 요구사항이 하도 뒤바뀌어 한 일이라고는 매일 소스를 이리엎었다 저리엎었다 한 것을 시간대별로 기록한, 폰트크기 10의 글자로 a4용지 50장 분량은 되는 개발내역을 책상 위에 내던지는데 사용할 수도 있다.

또한 부수적으로, 프로젝트 종료 후에 인스톨 가이드나 개발관련 산출물 따위를 만들라는 시시한 요구를 받았을 때, 이 개발 로그를 훑어보고 내역을 정리하면 그나마 구멍이 덜 난 문서를 '빨리' 작성할 수 있을 것이다. (결국 이 포스트의 핵심은 '빨리'에 있다)

* 개발 로그 조낸 빨리 남기기 ; 메모장 빨리 띄우기

하지만 이런 개발 로그를 남기기 위해 '시작 버튼 -> 프로그램 -> 보조프로그램 -> 메모장' 메뉴를 한가롭게 클릭하고 앉아있다던가, 약간의 센스를 발휘해 시작 메뉴에 메모장을 등록한다고 하더라도, 그것은 너무 느리다. 키보드에서 마우스로 손이 이동하다니! 안될 일이다.

'시작 버튼 -> 프로그램 -> 보조프로그램 -> 메모장' 메뉴를 찾아가서, '메모장' 메뉴를 우클릭하자.

위 그림의 '바로 가기 키' 텍스트 박스를 클릭하고, 쓰고 싶은 단축키(위에서는 N)을 입력하고, 확인을 눌러 창을 닫으면 된다. Ctrl + Alt + N을 누지르면 메모장이 툭 튀어나오는 것을 볼 수 있을 것이다. 그러면 마구 적고 어딘가 저장하면 그만. (참고로, 날짜/시간 자동 입력은 메모장에서 단축키 F5를 누르면 된다. 설마 내가 저 날짜/시간을 날짜 및 시간 등록정보를 보고 입력하고 앉아있을거라고 생각하셨는가?) Ctrl + Alt 입력 조합이 좀 부담스럽긴 하지만 기존 어플리케이션과의 단축키 충돌을 피해가기 위한 조치라고 생각하고 봐주도록 하자. 물론 Ctrl + Alt + Del 조합 때문에라도 이미 익숙하리라 생각되지만.

하지만 이것으로도 2% 부족하다.. 아무리 빨리 메모장을 열어봤자, 개발 로그를 남기던 기존의 텍스트 파일이 있을 것이고, 메모장에서 또 '파일 -> 열기' 메뉴를 선택하고... 아, 아니다. 이건 아닌것이다. 물론 개발 로그 텍스트 파일을 바탕화면에 깔아놓는 방법도 있지만, 그것 또한 손이가요손이가마우스에손이가요 작업 아니던가.

그래서 다음 방법을 제안한다.

* 개발 로그 조낸 빨리 남기기 ; 아예 텍스트 파일을 빨리 띄우기

그렇다. 아예 개발 로그 텍스트 파일을 단축키로 쌔우면 될 터인데...

여기에서 혹시라도!

'단축 아이콘'을 생각해낸 당신을 윈도 데스크탑 전문가로 인정합니다-

냅다 '바로 가기 만들기'를 클릭하고 바로 가기 아이콘을 우클릭해서 속성을 보자.

(참고로 나는 Ctrl + Alt + M이라는 단축키를 쓴다)

자 이걸로 확인 버튼을 누르고 Ctrl + Alt + M을 누르면 메모.txt 파일이 열리겠쿠나!

네. 열어서 쓰시면 됩니다.

* 현재 win2003 환경에서는 저렇게 단축키를 설정하고 해당 단축키를 누르면 곧바로 메모.txt 파일이 열리는 것을 볼 수 있으나, (내 기억이 정확하다면) win2000 이전 버전에서는 해당 바로 가기 아이콘을 시작 메뉴에 추가해줘야 단축키가 동작하기 시작한다. win2000 사용하면서 '이거 왜 안돼 개뻥이잖아'라고 울부짖으면 할 말이 없...

* 마무리

하루빨리 다들 이런 허접한 개발 로그를 남기지 않아도 되는 회사로 무사히 탈출하시기를 빈다. 이상.

p.s:눈치를 챈 사람도 있겠지만, 케냘의 데스크탑은 이런 단축키로 완전 오염상태. 예를 들면(물론 Ctrl + Alt 키의 조합과 함께 눌러서) W는 윈앰프, E는 IE, D는 콜린스코빌드 영영사전, N은 메모장, M은 메모.txt, I는 아이튠즈, F는 파일질라, V는 vs2003, C는 VC++ 2005 뭐 막 이런 식으로... 물론 이런 단축키는, '시작 -> 프로그램' 메뉴에 있는 각 프로그램의 아이콘의 등록 정보에서 바로 가기 키를 편집하면 사용할 수 있다. 케냘이 노트북을 운용하는 것을 본 사람 중에서는, 케냘의 노트북에만 이런 특별기능이 있는거라고 생각하는 사람도 있는 듯 하다 -_-;