문서화 글 모음

1. 뱅크샐러드의 특별한 스펙, '테크 스펙'

 

> 코드 짜기도 바쁜 우리는 문서까지 작성할 시간이 없습니다. 대부분의 소통을 코드로 할 때가 많아 글로 소통하는 방법에 익숙하지 않기도 하고, 한 번 작성된 후 업데이트되지 않는 문서는 시간 들여 필요 없는 문서를 양산해버린 셈이 되니까요. 그럼에도 우리는 쉽게 문서화 라는 마법의 단어를 말하고는 합니다.

 

> 복잡도가 증가한다는 것은 더 많은 함정을 만드는 일입니다. 그리고 개발자의 일은 이 복잡도를 제어하는 것이죠. 복잡도를 제어할 수 있는 가장 좋은 방법은 휘발성이 높은 Short Term Memory로부터 👉 의도와 목적을 조율할 수 있는 수단으로 나아가는 것입니다. 그래서 뱅크샐러드는 테크 스펙을 쓰기 시작했습니다.

 

>

🤔 테크 스펙이 뭔데?

직독 직해하시면 됩니다. 기술(tech) 설명서(spec)를 말해요. 기능을 구현하기 전에 이 기능을 어떻게 구현할 것인지 기술적으로 풀어 설명하고, 제안하는 글이에요. 보통은 기능에 대한 기획적인 부분을 보고 바로 개발자가 작업하게 되지만, 테크 스펙은 실제 개발에 바로 들어갈 수 있을 것 처럼 자세하게 적어서 실제 플랫폼 코드가 포함되는 경우도 많아요.

 

> 우리는 보통 문서화를 귀찮게 생각합니다. 문서화는 코딩과 별도의 일이라고 생각하기 때문이죠. 하지만 테크 스펙을 써 보면, 어떻게 만들 것인지 줄줄이 작성하면서 이미 웬만한 수준의 코딩이 들어가게 됩니다. 결과적으로 테크 스펙을 다 작성하고 나면 테크 스펙에서 작성했던 코드를 실제 프로덕트에 붙이는 것만으로 작업이 끝나기도 하죠. 즉, 문서화는 더이상 코딩과 별도의 일이 아니게 됩니다.

테크 스펙은 모든 과정을 투명하게 만듭니다. 베스트 프랙티스들로 문제를 해결하게 해 주고, 일정 산정에서 개발자에게 부담을 덜어주고, 설사 비즈니스 상황이 바뀌어 일정이 바뀐다고 하더라도 그건 상황이 바뀌었을 뿐 개발자의 실책이나 과오가 아닌게 명백히 보이기 때문에 개발자가 부담 없이 자유롭게 일할 수 있는 환경을 제공합니다.