코드 분석 및 시스템 문서 생성기

# 임원 및 비즈니스 분석 보고서 - "<애플리케이션 이름>" ## 문서 요약 본 문서는 <시스템 이름> 시스템의 소스 코드 분석 결과로서 다음 영역을 다룹니다: - **임원 수준 개요**: 애플리케이션의 목적, 높은 수준의 작동 방식, 주요 비즈니스 규칙 및 핵심 이점 요약 - **기술 수준 개요**: 시스템 아키텍처, 사용 기술, 주요 흐름, 핵심 구성 요소 및 다이어그램(구성 요소, 데이터 흐름, 클래스, 배포)에 대한 세부 정보 - **제품 관점**: 시스템 기능의 상세 설명, 대상 사용자, 해결되는 문제, 주요 사용 사례, 기능 및 비즈니스 도메인 - **분석 제한 사항**: 주요 분석 제약 조건 식별 및 해결 방안 제안 분석은 사용 가능한 소스 코드 파일을 기반으로 수행되었습니다. --- ## 1. 임원 수준 개요: 경영진 요약 ### 애플리케이션 목적 - 이 시스템의 주요 목적은 무엇인가? - 높은 수준에서 어떤 문제를 해결하고자 하는가? ### 작동 방식 (높은 수준) - 비기술적 독자를 위해 전체 시스템 흐름을 간결하고 이해하기 쉽게 설명 - 시스템이 수행하는 주요 단계 또는 프로세스는 무엇인가? ### 높은 수준의 비즈니스 규칙 - 코드에 구현된 주요 비즈니스 규칙 식별 및 설명 - 시스템이 따르는 기본 비즈니스 정책, 제약 조건 또는 로직은 무엇인가? ### 주요 이점 - 이 시스템이 조직 또는 사용자에게 제공하는 주요 이점은 무엇인가? --- ## 2. 기술 수준 개요: 기술 개요 ### 시스템 아키텍처 - 코드 분석을 기반으로 전체 시스템 아키텍처 설명 - 특정 패턴(예: 모놀리식, 마이크로서비스 등)을 따르는가? - 식별된 주요 구성 요소 또는 모듈은 무엇인가? ### 사용 기술 (기술 스택) - 프로젝트에서 사용된 모든 프로그래밍 언어, 프레임워크, 라이브러리, 데이터베이스 및 기타 기술 나열 ### 주요 기술 흐름 - 시스템 내 주요 데이터 및 실행 흐름 상세 설명 - 서로 다른 구성 요소는 어떻게 상호 작용하는가? ### 핵심 구성 요소 - 가장 중요한 시스템 구성 요소를 식별하고 아키텍처 내 역할과 책임 설명 ### 코드 복잡성 (관찰 사항) - 분석을 기반으로 코드 복잡성에 대한 일반적인 관찰 제공 (예: 잘 구조화됨, 모듈화됨, 높은 복잡성 영역) ### 다이어그램 - 시스템 아키텍처 및 동작을 시각화하는 높은 수준의 다이어그램 생성: - 구성 요소 다이어그램 (주요 모듈 및 상호 작용 중심) - 데이터 흐름 다이어그램 (정보가 시스템을 통해 이동하는 방식 표시) - 클래스 다이어그램 (해당되는 경우 주요 클래스 및 관계 표시) - 간소화된 배포 다이어그램 (구성 요소가 실행되는 위치 표시, 감지 가능한 경우) - 간소화된 인프라/배포 다이어그램 (인프라 세부 정보가 명확한 경우) - 위 다이어그램을 Markdown 파일 내 Mermaid 구문을 사용하여 생성. 다이어그램은 높은 수준으로 유지하고 지나치게 상세하지 않아야 함 --- ## 3. 제품 관점: 제품 요약 ### 시스템 기능 (상세) - 시스템의 주요 기능을 상세히 설명 - 사용자가 수행할 수 있는 작업 또는 행동은 무엇인가? ### 시스템 대상 (사용자/고객) - 시스템의 주요 대상 청중 식별 - 혜택을 받는 최종 사용자 또는 고객은 누구인가? ### 해결하는 문제 (충족되는 요구) - 시스템이 사용자 또는 조직을 위해 해결하는 특정 문제는 무엇인가? - 충족하는 요구는 무엇인가? ### 사용 사례 / 사용자 여정 (높은 수준) - 시스템의 주요 사용 사례는 무엇인가? - 사용자는 목표를 달성하기 위해 시스템과 어떻게 상호 작용하는가? ### 핵심 기능 - 가장 중요한 시스템 기능을 명확하고 간결하게 나열 ### 비즈니스 도메인 - 시스템이 다루는 주요 비즈니스 도메인 식별 (예: 영업, 재고, 재무) --- ## 분석 제한 사항 - 코드 분석 중 직면한 주요 제한 사항은 무엇인가? - 코드 이해를 제한한 요소를 간략히 설명 - 이러한 제한 사항을 줄이거나 제거하기 위한 제안 제공 --- ## 문서 지침 ### 문서 형식 - 문서는 Markdown 형식으로 작성되며 각 섹션에 명확한 제목과 부제목 사용 - 목록, 표 및 기타 Markdown 요소를 사용하여 가독성과 이해도 향상 ### 추가 지침 - 관련성이 높은 높은 수준의 정보를 전달하는 데 집중하고, 이해에 중요하지 않은 과도한 구현 세부 사항은 피할 것 - 여러 청중에게 적합한 명확하고 간결하며 접근 가능한 언어 사용 - 코드 분석을 기반으로 가능한 한 구체적으로 작성 - 완전한 응답을 잘 구성된 Markdown(.md) 문서로 생성 - 명확하고 직접적인 언어 사용 - 위 섹션에 따라 제목과 부제목 사용 ### 문서 제목 임원 및 비즈니스 분석 - "<애플리케이션 이름>" --- ## 중요 분석은 모든 프로젝트 파일을 고려해야 합니다. 작업을 수행하고 시스템에 대한 완전한 이해를 달성하는 데 필요한 모든 파일을 읽고 이해하십시오. --- ## 작업 현재 내 환경/작업 공간에서 사용 가능한 소스 코드를 분석하고 요청된 Markdown 문서를 생성하십시오. 출력 파일 이름은 다음 형식을 따라야 합니다: <yyyy-mm-dd-project-name-app-discovery_cursor.md>