문서화

 이전에 개발한 소프트웨어를 문서화하였다. 프로토콜에 대한 정리를 다른 회사와 공유하고 팀내에서 협업을 위해 사용하고자 함이다. 대외적으로 공개 할 수도 있는 문서니이 양식은 좀 신경쓴거같다. 용어 정리, 통신 흐름도, 아키텍처 구성 ..

 

 공유하고자 하는 문서에는 어느 내용이 들어갈지도 되게 중요하다. 우리 회사 소프트웨어 자체적으로 쓰이는 로직도 넣을지 외부 통신하는 로직만 넣을지... 팀 내에서는 어떤방식으로 프로토콜을 만들지 논의한다.

 

음 ... 여러 방식이 있는데 무조건 내주장을 내세우진 않았고 일부러 이런 방식을 생각한다고 떠 보았다.. 조금은 RestFul한 방식으로 설계하고자 미리 생각했는데 팀원분 코드를 보니까 원하는 방향으로 되진 않아서 떠 본 것이기도 했다. 

 

"난 항상 이런식으로 개발했어~" 라는 말에 바로 상대가 원하는 방식으로 바꿨다. 이왕이면 서로가 알고 있는 방식으로 개발하면 좋다고 생각했다. 

 

 문서를 만들 때는 귀찮았는데 만들고 나니까 오히려 업무 소통도 명확해지고 상대가 크로스 체크 해주면서 문서 오탈자도 잡아주고 좋았다. 또한 업무 의존성 분리가 가능했다. 한 쪽이 기능개발 + 문서화 해놓으면 다른쪽에서 이후에 그대로만 따라하니까 업무 진행이 편했다. 

 

 이전에 문서화를 대충 해놓았더니 그 문서가 버려지고 오히려 코드로만 업무 소통이 된 적이 있었는데... 

 

이번에는 뭔가 달랐다. 문서화의 필요성....!