diagram-generator은(는) 무엇을 하나요?
코드, 스키마, 요구사항을 기반으로 Mermaid 우선 소프트웨어 다이어그램과 간결한 아키텍처 문서를 생성합니다.
기능
- 코드베이스 구조 파악 및 시각화
- 데이터베이스 스키마에서 ER 다이어그램 생성
- 요구사항 명세에서 시스템 아키텍처 다이어그램 도출
- Mermaid 문법을 사용하여 버전 관리 및 협업 용이
- 지원 다이어그램: 클래스 다이어그램, 시퀀스 다이어그램, 플로우차트, ER 다이어그램, 아키텍처 다이어그램
사용 방법
- 분석할 코드, 스키마 또는 요구사항을 제공합니다.
- 생성할 다이어그램 유형을 지정합니다.
- 필요에 따라 추가 컨텍스트나 세부 사항을 제공합니다.
- 결과 Mermaid 다이어그램과 설명을 확인합니다.
예시
입력
시스템: 주문 관리 서비스
엔티티: 주문, 고객, 제품, 결제
관계: 고객(1) -> 주문(N), 주문(N) -> 제품(M), 주문(1) -> 결제(1)
출력
erDiagram
CUSTOMER ||--o{ ORDER : places
ORDER ||--|{ PRODUCT : contains
ORDER ||--|| PAYMENT : has
참고 사항
- 생성된 다이어그램은 Mermaid 라이브러리 호환 문법을 따릅니다.
- 다이어그램은 코드베이스의 실제 구조에 기반하여 생성되며, 사용자 제공 컨텍스트에 따라 조정됩니다.
- 여러 다이어그램 유형을 결합하여 종합적인 아키텍처 문서를 만들 수 있습니다.