사내 위키 도입하기

hyob·2020년 6월 18일
1

🙉머릿말

이 글은 제가 팀원들에게 위키(기능명세서)를 제안하고 도입하게된 이야기 입니다.
그동안 이런저런 개발을 하고는 있지만, 딱히 글로 쓸만한 주제가 없었네요..
그래서 제가 위키라고 부르는 기능명세서(기술 아닙니다) 도입 경험이라도 적어보려 합니다🏃🏻‍♂️

1년 전쯤..👀

네. 작년이 이런 일이 있었어요.
디자이너가 본인이 기획한 새 피쳐 작업에 대한 QA를 하고 있었습니다.
새 기능이 포함된 앱을 설치한 디바이스와 현재 앱스토어 버젼 앱이 설치된 디바이스 두개를 비교하면서 확인을 하는거에요...

'왜 그렇게 두개 놓고 비교하세요?'
'예전 기능이 기억 안나서요.. 혹시 이거 어떻게 동작하는지 알고 계세요?'
(코드를 뒤적거린다..)

이때 처음 '우리 기능명세서 만들어 볼까요?' 라고 슬쩍 얘기해 봤는데, 별 반응이 없더라구요 ㅋㅋㅋ
'지금 말고 나중에' 같은 말만 돌아왔습니다.

그 동안 비슷한 일이 있을때 마다 저는
'기능명세서?'
를 외치면서 잽을 날렸으나 여전히 못들은척😈

🤬아니 기획서가 있는데 뭣 하러?

네 기획서 있죠..
저희팀은 그동안 트렐로, 노션, 심지어 구글독스 까지 여러 곳에 기획서를 저장하고 있었습니다.

기획서는 사실상 정리되지 않고 있었고, 지난 기획서들을 찾는것도 아주 힘들었어요.

힘들게 과거의 기획서를 찾았다?
기획 히스토리부터 QA리스트, 중간에 변경된 사항들.... 기술적인 내용...
기획서에 담겨있는 내용이 너무 많아 필요한 정보를 찾기가 어려워요..😱

그래서 모든 사람들이 개발자를 찾아갑니다. 옆에 앉아있으니 그냥 가서 물어 보면 편하죠.
그런데 그 개발자분도 모든것을 기억하진 못하잖아요?
코드를 뒤적거립니다.

여기서 또 문제가 있어요ㅋ

현재의 코드가 원래 기획 의도 되로 개발된 코드인지 혹은 다르게 개발된(버그)인지 알수 없는 경우가 더러 있었죠.

이 경우, 보통 그 자리에서 해당 기능을 재정의 하곤 했습니다.
그리고 어딘가에 기록.. 안하죠🤮

계속 돌림노래 같았어요 ㅋㅋㅋ

'기획자님! 이거 어떻게 동작하는거죠?'
'저는 기억안나는데, 개발자님 이거 어떻게 동작하는거죠?'
'저는 앱개발자라.. 벡엔드 만드신 분한테 물어볼까요? 백엔드님 이거 어떻게 동작하는거죠?'
'저도 기억안나는데.. (코드 뒤적뒤적) 이렇게 동작합니다.'
'아 그거 이번에 바꿔야 할 것 같아요. 바꿔주세요.'
(변경사항 기록 안함)

이런일이 어느샌가 모든 사람들에게 빈번히 일어나고 있었습니다.📈

원기옥⚪️🧨

최근에는 계속 채팅 관련된 추가기능 개발을 진행하고 있었어요.

제가 먼저 백엔드 작업과 프론트 작업(웹, iOS 중 하나)을 하면, 나머지 플랫폼개발을 다른 앱 개발자분이 진행하는 식이었어요.

앱 개발자분들이 사전 회의없이 기획서만 보고 작업을 진행하다보면 의문점들이 항상 나옵니다. 그 때 해당 태스크의 기획자를 찾아가죠. 그때 나오는 대답은?

이거 만드신분 찾아가서 물어보세요.

예예.. 저한테 옵니다.(아니면 다른 백엔드 개발자 분)
다행스럽게도 만든지 얼마 안된 거라 기억이 슝슝 나요 ㅎㅎ
또 기억 안나면 코드 뒤적이면 되니까요 !
잘 설명 드리고, 잘 이해하시면 떠나십니다 😅

하지만 저는 작년에도 그랬고 지금도 계속 이것이 문제상황이라고 생각해요🤦🏻‍♂️

해당 기능을 만든 개발자가 휴가를 떠나면?
퇴사하시면?
물어보러 오시는 분들의 발걸음이 무거워 지는 듯한 느낌인데?
묻기 미안해 하시나?

ye..
이번엔 민심을 끌어 모았습니다.
기를 모은거죠 ㅎㅎ
다행히 작은 원기옥 하나 날릴 수 있을정도는 되었던것 같네요!
그 다음주 회고 자리에서 위키에 대해 논의 했습니다.

그래서 그 위키 누가 관리할건데⚠️

또 귀찮은거 하나 생기겠네

라고 생각할까봐 걱정 많이 했습니다.
그래서 누구 한명이 책임지는것이 아닌, 모두가 함께 작성하고 관리하는 위키를 만들려고 했어요🙈

제가 위키 이야기를 꺼냈으니 총대를 메고..
흐지부지 될까봐 가이드라인을 만들어 왔습니다.

일단 쉽게 시작하려고 했어요. 그래서 노션을 이용했습니다.

각잡고 문서화 한다기 보다는 새로 진행되는 태스크 위주로 기능을 정리해 나가려고 했습니다.

크게 중요시한 점들이 있어요 🐭

  1. 궁금한 점들을 위키에서 찾아볼 수 있도록 하자.
  2. 직무를 떠나 모두가 읽고 이해 할 수 있는 내용으로 채우자.
  3. 불필요한 내용은 적지 말자.(기획 히스토리. 기술적인 내용들)

마무리

위키는 점점 많은 분들이 작성해 주시고 계세요 ㅎㅎ
형태가 아직 잘 잡히지는 않았지만, 앞으로 나아질 것 같습니다.
기분탓인지 모르겠지만, '이 기능이 어떻게 동작하는거죠?' 같은 질문들이 줄고 있는것 같아요 ㅋㅎ

이번 원기옥에서 깨달은 점은..

답답하면 늬들이 뛰던가

에서 늬들이 되어야 한다?
슬쩍 슬쩍 건의하지말고 확실하게 밀어부쳐야 한다?

점점 개발이나 코드 외적인 부분에 신경이 쓰인다?

Rmx~

profile
앵커리어에서 자소설닷컴을 개발하고 있습니다.

0개의 댓글