Typescript source file을 문서화하기

비브로스 백엔드 팀은 서비스 운영에 필수적인 Mongoose 스키마와 API 인터페이스 관리에 어려움을 겪었습니다. 기존에는 Confluence에 수동으로 문서를 작성하고 수정하여 누락이나 오기가 발생할 수 있었고, 스키마 정의, Mongoose Schema, Interface, Confluence 문서까지 세 가지를 관리해야 하는 번거로움이 있었습니다.

이 문제를 해결하기 위해 Typescript Interface를 분석하여 자동으로 Markdown 파일을 생성하는 라이브러리를 개발했습니다. 이 라이브러리는 Typescript 패키지의 강력한 파싱 기능을 활용하여 Typescript AST(Abstract Syntax Tree)를 추출하고, 이를 기반으로 문서를 생성합니다.

이를 통해 관리 포인트를 줄이고 정보의 일관성을 유지하여 개발 생산성을 향상시킬 수 있습니다.