Typescript source file을 문서화하기

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

이를 해결하기 위해 Typescript Interface를 분석하여 자동으로 Markdown 문서를 생성해주는 라이브러리를 개발했습니다. 이 라이브러리는 Typescript 패키지의 강력한 파싱 기능을 활용하여 Typescript AST(추상 구문 트리)를 분석하고, 이를 기반으로 문서를 자동화하여 관리 포인트 감소 및 정보 일관성 유지에 기여합니다.