문서화

Docs

문서화는 유지보수 측면에서 매우 중요한 요소

• 컴포넌트가 어떤 의도인지, 어떻게 사용되는지를 설명하는 중요한 문서

Storybook MDX

• 사내 라이브러리는 작성자와 사용자 모두에게 접근이 용이해야 하며, 스토리북은 접근성이 뛰어남

• 문서화, 테스트, 디버깅을 같은 환경에서 작성한다면 문서와 실제 코드 간의 싱크 오류(파편화)를 줄여줌

• 설명, 코드, UI를 한 화면에 함께 배치 가능 → 이해도 ↑

Nextra

• 외부에 보여지는 문서를 작성할 때 유용한 정적 사이트 생성기

• Next.js에 익숙한 개발자에게 진입 장벽이 낮고 관리가 쉬움

• 마크다운 문법으로 쉽게 작성할 수 있고, 필요시 리액트 컴포넌트도 삽입 가능 → 문서 작성과 컴포넌트 예제를 함께 보여줄 수 있어 유연함