어쩌다보니 테크스펙 문서들을 작성해보게 되었다. 테크스펙 문서가 어떤 문서인지에 대해서는 다른 곳에서 너무 잘 이야기해주고 있어서 패스하겠다.
처음엔 누군가 시켜서 작성을 하게 되었다가 장점을 맛본 뒤에는 누가 시키지 않더라도 테크 스펙 문서를 작성하게 되었다. 아래에 상황들에 놓여져 있다보니 자연스럽게 테크 스펙 문서를 작성하게 되었던 것 같다.
- 특정 서비스의 히스토리와 관련 도메인을 아는 사람들이 퇴사하면서 나 밖에 남지 않았고
- 서비스를 개선하려거나 기능 추가를 하려고 할 때, 관련 배경이나 도메인을 모르는 팀원들이 대부분이라 리뷰를 받기 어렵다.
- 슬랙에서 이야기 하기에는 어디서부터 어디까지 슬랙을 통해 이야기를 해야 하는지 모르겠고 내용이 휘발되기 쉽다.
- PR 얘기하기에는 PR 이 너무 길어지고 문서화하기에 어렵다.
- + 숲을 보기 어려우니 lint 위주로 리뷰를 하게된다.
그렇다보니 테크 스펙 문서에 관련한 백그라운드 지식이나 히스토리 등을 테크스펙에 녹이면서 현 문제 상황과 이를 어떻게 해결하고자 작성하고, 목표는 이러저러하다와 같이 작성한 뒤에 리뷰를 요청하니 리뷰의 질이 좀 더 좋아짐을 느꼈다.
그로나 이 테크스펙 리뷰가 강제되지 않고 업무 프로세스로 잡히지 않았기에 하는 사람만 하거나 보는 사람만 보는 것 같긴 하다.
(그냥 채널에 리뷰 부탁드립니다~ 해서 그런 걸지도)
그래도 이렇게 테크스펙을 작성하면서 나만 혼자 알던 내용을 다 같이 알게 하고, 리뷰함으로 써 레거시를 좀 더 개선할 수 있게 되지 않을까 싶어서 내년에도 테크 스펙 문서를 잘 작성해보려고 한다.
반응형