RepoDoc

RepoDoc을 GitHub 저장소로 향하게 하면 실제 코드로 문서를 쓴다. 개요와 각 부분이 무엇을 하는지 설명하는 파일별 페이지를 얻는다. 폴더를 뒤지며 진입점을 짐작하는 것보다 낫다. 이 프로젝트는 Frontend, Backend, Full Stack, Library, CLI, Mobile App, General을 아우르는 7가지 템플릿을 제공하고, 주어진 저장소에 맞는 것을 자동 감지하므로 시작 전에 구조를 추측하지 않아도 된다. 융통성 없는 상용구가 아니라 자동 생성 코드 문서의 실용적인 원천이다.

다이어그램은 본문과 함께 생성된다. 아키텍처 뷰, 클래스 다이어그램, 시퀀스 흐름, 엔터티 관계를 포함한다. 렌더링은 Mermaid가 맡으므로, 순서도, 시퀀스 다이어그램, ER 다이어그램, 간트 차트, git 그래프 등까지 다이어그램 문법을 한 줄도 쓰지 않고 처리한다.

모든 저장소가 탐색 가능한 파일 트리와 문서 패널의 짝이 된다. 파일을 클릭하면 생성된 문서를 읽거나 저장소 개요를 볼 수 있다. 이 나란한 배치가 진짜 매력이다. 코드 구조와 글로 된 설명을 같은 화면에 두고, 브라우저 탭과 편집기를 오가게 하지 않는다.

생성기는 하나의 목소리에 가두지 않는다. Formal, Friendly, Technical 세 가지 문체 중에서 고르고, 도구가 쓰기 시작하기 전에 얼마나 자세할지 정한다. 덕분에 나중에 모든 문단을 다시 쓰지 않고도 독자에 맞춰 문서를 조정할 수 있다. Formal은 기업 문서에 어울리고, Friendly는 안내처럼 읽히며, Technical은 전문 용어에 이미 익숙한 개발자 독자를 전제한다. 잘못 고르면 문체가 내용과 부딪힌다.

완성된 문서는 브라우저에 갇히지 않는다. RepoDoc은 Markdown으로 내보내므로 내용이 기존 문서 사이트나 저장소에 그대로 들어간다. 공유와 보관을 위해 PDF로도 내보낸다. Markdown 내보내기는 문서를 이미 버전 관리에 두는 팀에 특히 중요하다. 내보내고, 커밋하고, 끝이다.

저장소는 변하고, 뒤처진 문서는 없는 것보다 나쁘다. RepoDoc은 저장소 데이터를 새로 고쳐 문서를 다시 생성할 수 있다. 전체 재작성을 강제하면 결과물이 낡은 스냅숏이 아니라 코드의 현재 상태를 반영한다. 구조가 주마다 바뀌는 활발한 개발 프로젝트에서 특히 중요한 부분이다.