brunch

You can make anything
by writing

C.S.Lewis

by 한별 Oct 27. 2024

뻔하디 뻔한 개발문서 중요성에 관한 이야기

같이 문서 작성해 달라는 그런 이야기

개발문서가 중요하니까 작성해야 한다라고 말하는 것은 마치 이런 이야기와 일맥상통한 게 아닐까 생각이 든다.

살을 빼고 건강해지려면 운동을 하면 되는 거고, 교과서대로 공부하면 우수한 성적을 받는다는 누구나 알지만 행하기 어려운 그런 이야기 말이다.


나 역시 개발문서가 중요하다는 건 알고 있었고, 팀의 문화로 자리 잡은 상태가 아니라 개인적으로 공유문서를 작성해두곤 했다.

지금 와서 하나 후회되는 건, 좀 더 의견을 내어 문서관리가 되도록 했어야 했다는 점이다.

현재 우리 팀은 구조조정과 희망퇴직으로 인하여 12명에서 6명 그리고 지금은 4명이 한 팀이다.

여기서 가장 끔찍한 게 뭔지 아는가? 업무가 몰린다는 거? 부정적인 분위기? 그것보단, 나를 가장 힘들게 하는 건 업무 히스토리를 알 수 없다는 점이다.

지금까지 작업 담당자에게 구두로 히스토리를 물어 전달받는 상황이었고 이제 물어볼 사람도 없으니 히스토리를 알 수 없게 되어버렸다.

이제 와서 생각해 보니까 개발문서를 제외하고도 참 체계 없이 어떻게든 잘 돌아가고 있었구나 싶다.


구조조정이 있기 전에 팀원 중 일부와 문서 관련해서 이야기한 적이 있었다.

돌아온 말은 하나같이 똑같았다.

"문서를 어떻게 작성해야 할지 모르겠다."
"깔끔하게 작성해야 하는 방법을 모르겠다."

아마 다른 분들도 똑같은 이유로 공유문서를 작성하지 않았던 게 아닐까 예상된다.


'글쓰기 근육'이라는 말을 들어본 적 있는가?

글쓰기는 운동과 같다.

부단한 연습이 필요하고 많이 써봐야 한다.

해보지 않으면 계속 그 상태고 나아질 수 없다.


나름 팀에서 '정리왕'이라는 요상한(?) 호칭을 받고는 있지만, 나 역시 원래 정리를 잘했던 것도 아니고 심지어 지금도 더 잘할 수 있는 방법이 없을까 여전히 고민한다.

내가 타 플랫폼 중 하나에 작성한 글만 해도 약 800개이며, 그 개수 그대로 전부 갈아엎은 적도 있고,
모든 플랫폼에 작성한 것까지 포함하면 이 글을 작성하고 있는 현시점까지 약 2,000개의 글을 작성했다고 봐도 무방할 거 같다.

그리고 1년에 12권 이상의 책을 읽고, 아티클은 매일 이것저것 읽어본다.

이 모든 행위가 나의 글쓰기 근육에 들어갔던 거고 처음부터 잘하는 사람은 없다고 생각된다.


히스토리를 담을 문서의 틀은 담당자밖에 쓸 수 없다.
그니까 정리 못한다 해서 안 쓰지 말고 그냥 나열이라도 좋으니 작성해서 공유해 주면 좋겠다.

정리 못한다고 누가 뭐라 하는 게 아니고, 모두가 편집이 가능하니까 아마 나중에 다시 그 문서를 봐보면 더 멋있게 탈바꿈되어 있을게 뻔하다. 코드와 비슷하다고 생각된다.


글의 제목을 '뻔하디 뻔한'이라고 쓰긴 했지만, 개발문서가 주는 효과들로는 ‘원활한 의사소통’과 무엇 무엇이 있다 이런 식의 내용으로는 굳이 쓰고 싶지 않았다 뭐 검색하면 잔뜩 나오니까 말이다.

다만, 기억력이 너무 좋거나, 회사에 뼈를 묻을 생각이 아니라면 추후 다른 사람을 위해 힘을 좀 써주었으면 했고, 이 글을 읽고서 누군가 영향을 받으면 그건 그것대로 좋은 일일 거 같아 이런 글을 작성해 본다.

매거진의 이전글 개발자로서 SI회사는 정말 가면 안 되는 걸까?
브런치는 최신 브라우저에 최적화 되어있습니다. IE chrome safari