2011년 2월 13일 일요일

어제 일도 기억하지 못하는데...

개발자들은 동서고금을 막론하고 대부분이 문서화를 싫어하는 경향이 있다. 문서화는 시간이 많이 걸린다고 생각하고 기껏 정리를 해 놔도 남들이 잘 이해하지 못하기 때문이다.

이 생각에 동의한다면 문서화 자체를 완전히 잘못 생각하고 있는 것이다. 문서화를 지금 개발하고 있는 것을 기록해서 나중에 다른 사람들이 활용할 수 있게 한다는 추가적인 작업으로 생각하고 있을 가능성이 높다.

문서화에 대한 생각을 완전히 바꿔보자.

대부분의 개발자들은 기억력이 매우 좋다고 생각하지만 의외로 그렇지 않다. 특정 부분에 있어서 뛰어난 기억력을 발휘하는 경우는 있다.

갑자기 머리에서 번뜩인 아이디어를 10초안에 정리하지 않으면 영원히 사라져 버리는 경우는 흔하다. 하물며 수많은 내가 하고 있는 해야 하는 일들은 시간이 흐르면 내 머리 속에서도 사라져 버린다. 이런 것들을 사라지기 전에 기록한다고 생각하자. 그러려면 특정 형식에 얽매이지 않고 어디서나 기록을 할 수 있 툴들이 필요하다.

간단한 메모장에서 부터 스마트폰과 연동하는 노트 앱이나 클라우드에 저장하는 메모 앱들도 있다. 마인드맵을 이용하는 방법도 있다. 용도에 따라서 다양한 방법들은 각자 구미에 맞는 것들을 선택하면 된다.

이렇게 항상 메모하는 습관을 가지고 있으면 의외로 엄청난 변화를 경험하게 된다. 머리 속에만 있던 생각이 글자로 적히게 되면 점점 발전되어서 머리속 가지고 있을 때보다 가치있게 된다. 또한 다른 사람들과 공유가 가능하고 다른 사람들의 생각과 합쳐서 더 좋은 아이디어로 발전하기도 한다.

이런 메모 습관은 글을 작성하는 것에 대한 거부감을 줄여나가고 개발문서 작성할 때도 도움을 주게 된다. 

나는 오랫동안 메모를 해 왔다. 

아주 오래 전에는 작은 수첩에 메모를 하는 것이 가장 효율적이었다. 그 때는 이를 다시 정리하는 시간이 필요해서 꽤 불편했었다. 하지만 이제는 너무나 좋은 툴들이 너무나 많아서 좋은 것을 선택하는 것이 오히려 어려울 정도다.

과거 OneNote를 사용한 적도 있지만 이제는 Evernote를 이용하고 있다. Evernote는 그동안 메모를 하면서 생각하고 있던 요구사항을 거의 모두 만족한다. 물론 이것 외에도 좋은 툴들이 많으니 입맛에 맞는 것을 선택하면 된다.

우선 아이폰을 이용해서 "텍스트", "음성", "카메라" 메모를 모두 쉽게 남길 수 있다. 이렇게 남긴 메모는 아이폰, 맥, PC에서 모두 접근 할 수 있고 편집할 수 있다. 게다가 무료이다. (유료서비스도 있음)
신기한 기능 중에 하나는 "카메라"로 촬영한 이미지 안의 "텍스트"도 검색이 되는 것이다.
설계 회의를 하다가 화이트보드에 그려 놓은 그림을 사진을 찍어 놓으면 내용을 검색할 수 있는 것이다.

여기에는 거의 모든 내용을 항상 기록한다. 길을 가다가 생각난 모든 것을 기록한다. 스펙을 작성할 때도 이렇게 모인 자료들이 많이 활용된다.

문서화를 남을 위한다고 생각하지 말고 자신이 일을 할 때 자신을 위해서 항상 기록한다고 생각하면 문서화 실력도 조금씩 더 향상될 것이다. 다시 한번 생각하자. 남을 위한 것이 아님을.

댓글 6개:

  1. 에버노트 정말 물건인것같아요 이년전부터 사용하고있는데 할일, 웹상에서 스크랩한것, 아이디어를 적고있습니다
    희미한잉크가 선명한기억보다 오래간다는 말이 요새 절실히 느끼고있습니다.
    SRS 작성은 여전히 어렵네요 흑흑
    이곳에 문서화에대해서 정말 많이 배우고있습니다 감사합니다

    답글삭제
  2. 안녕하세요. 오산돌구님
    에버노트를 쓰고 계시는 군요. 정말 좋죠.
    SRS를 쓰는 방법을 즉, 요구사항을 분석해서 스펙을 작성하는 방법을 제대로 배우거나 경험하지 않고 제대로 작성한다면 "기적"일 겁니다.
    골프를 책보고 배울 수 없는 것과 비슷합니다.

    답글삭제
  3. 출판하신 책말고 다른 학습방법은 없나요? 비용이들어도 배우고싶습니다

    답글삭제
  4. 오산돌구님 안녕하세요.
    책에서도 설명이 되어 있습니다. 미국 소프트웨어 회사에 취업하여 몇년 정도 배우는 방법이 있고, Requirement Specialist에게 배우는 방법이 있습니다. 실제 프로젝트를 진행하면서 Requirement Specialist와 SRS를 직접 작성하면서 배우는 방법입니다. 책에서 이 방법이 유일한 방법이라고 설명이 되어 있습니다. 잘 찾아보세요. ^^
    실제로 저희 회사에서는 소프트웨어 분석 능력 향상 교육을 여러 회사를 대상으로 진행하고 있습니다.

    답글삭제
  5. 음.. onenote 이런게 좋다고 하는데 저는
    Windows Tablet Edition에 들어있는 필기장(journal)을 이용하고 있답니다.
    타블렛 노트북(일반 터치가 아닌 전자유도식 타블렛입니다)이기 때문에 정말 필기장은 손으로
    메모지에 쓰는것 처럼 촥촥 쓰고, 너무 크게 써서 공간이 없으면 선택하고 축소해서 또 쓰고
    이런식으로 활용하고 있죠. 아무튼 그게 없으면 공책이라도 들고 다니는데 이상하게
    적을것을 안들고 다닐때에만 기발한 아이디어가 떠오르더라구요 ^^;

    답글삭제
  6. 구차니님 안녕하세요.
    저도 한 3년간 타블렛PC(OS는 XP Tablet Edition)에서 OneNote를 썼었습니다. 제것도 전자유도식이었습니다. Journal도 좋은 툴이군요.
    요즘은 주로 타이핑을 하거나 음성으로 정리를 하는데 그러다 보니 옛날의 필기 방식이 가끔 그리워지거나 필요할 때가 있더군요. ^^

    답글삭제