테크 블로그 작성기 회고

테크 블로그에 글을 써서 올린 지 두 달이 지났지만, 테크 블로그에 글을 쓰고 나서의 회고를 써보고자 한다.

테크 블로그에는 전자증명서 리액트 페이지 및 레이어 동적 라우팅이라는 주제로 글을 작성하여 포스트 하였다.

시작

처음 글을 쓰게 된 시작은 인증 서비스 팀원들과 노션에 본인이 작업한 내용들을 문서화하여 공유하자는 것에서부터 시작이 되었다. 본인이 작업한 내용의 히스토리를 함께 작업하는 동료들에게 문서화해서 기록하고 공유하자는 취지에서 노션에 문서화를 진행하였다.

전자증명서 오픈 이후에 코드를 보여 리팩토링할 부분들이 없는지 살펴 보던 중에 라우팅 처리 부분의 코드를 개선해보면 좋을 것 같아 작업을 시작하게 되었고 해당 작업을 문서화하였다.

진행

처음 노션에 문서화를 하는 것 자체는 어렵지 않았다. 작업을 시작하게 된 계기를 시작으로 수정 이후에 어떠한 장점들이 있을지 정리하였다. 그리고 작업 순서대로 간단한 코드를 기반으로 설명 들을 작성하였다.

그러던 중 카카오 테크 블로그 관련 얘기를 듣게 되었고 노션에 정리한 내용을 테크 블로그에 올리면 어떨까 하는 생각이 들어 함께 서비스를 진행하는 팀원분들에게 공유 이후 파트장님에게 테크 블로그 작성 요청을 드리고 진행을 시작하였다.

일단 기존에 작성하였던 노션 문서 내용 보강이 필요해 보여 사용한 기술들에 대한 설명 및 링크 첨부 그리고 기존에 작성하였던 내용들에 살을 더 붙여 보강하였다. 그리고 마지막으로 간단하게 작업을 하며 느꼈던 부분들을 작성하는 것으로 마무리하였다.

작성한 문서를 테크 블로그 담당자분에게 전달 이후 해당 문서화 내용을 마크다운으로 변경하여 테크 블로그 게시에 도움을 주셨다.

문제

노션에 처음 문서화를 할 때 설명을 위한 코드들을 수도 코드로 작성하였는데 테크 블로그에 게시할 때에 해당 코드들의 인덴트나 괄호가 맞지 않게 작성되어있던 코드가 그대로 올라가 문제가 있었다. 처음 팀 내 톡방에 공유가 되었고 해당 부분을 읽은 팀원분 중 한 분이 해당 문제점을 지적해주셔서 추가 수정에 들어갔다.

노션에 작성하였던 문서화를 마크다운으로 변경하여 테크 블로그 게시를 위한 에디터에 작업 중 코드 부분이 정상적으로 노출되지 않는 현상이 발생하였다. 해당 문제를 해결하기 위해 코드를 수정하고 문서 내용도 수정하며 정상적으로 노출되도록 변경을 시도하였다. 해당 문제는 추가 수정 시에도 계속 문제가 되어서 코드 수정이 빠르게 되지 못하여 문제가 있는 코드 상태로 외부에서 작성된 블로그 글을 읽으신 분들도 계셨을 것으로 예상된다.

해당 부분으로 인하여 불편을 겪으셨던 분들에게 늦었지만, 지금이라도 이 글을 빌어 사과드립니다.

회고

마지막으로 테크 블로그에 글이 게시되고 나서 작업하였던 코드에서 문제점이 발견되어서 수정한 부분이 있었다. 배포 이후 어느 정도의 기간을 거치고 안정화가 되고 나서 글을 작성했더라면 이러한 문제점과 해결한 내용도 함께 작성할 수 있진 않았을까 하는 아쉬움이 있다.

이번 테크 블로그 게시를 해보며 외부에 공유되는 글인 만큼 조금 더 신중하고 팀 내에 추가 공유 및 크로스 체크를 완벽하게 한 후에 외부에 공유가 되도록 해야겠다고 생각하게 되었고, 다음에 이러한 기회가 또 주어진다면 해당 부분들을 개선하여 조금 신중하게 작업을 마무리 짓도록 해야겠다.

[Ref]:

• 전자증명서 리액트 페이지 및 레이어 동적 라우팅 - 카카오테크