Skip to content

Soyflat/Decop

Repository files navigation

DeployDoc Copilot

은행 IT 배포 프로세스에서 작성하는 "업무 변경 정의서" 문서를 AI가 자동 보완하고, 최종 문서를 기반으로 테스트 케이스를 자동 생성하는 도구입니다.

기술 스택

  • Frontend: Next.js 14 (App Router), React, Tailwind CSS
  • Backend: Next.js API Routes
  • Database: PostgreSQL (Neon)
  • ORM: Prisma
  • AI: OpenAI API
  • Deployment: Vercel

프로젝트 구조

app/
  layout.jsx              # 루트 레이아웃
  page.jsx                # 메인 화면 (단계별 UI)
  globals.css             # 전역 스타일
  api/
    coverage/route.js     # Coverage 분석 API
    ai-review/route.js    # AI 검수 API
    testcases/route.js    # 테스트케이스 생성 API
    change-definitions/
      [id]/route.js       # 변경 정의서 CRUD

components/
  DraftInput.jsx          # 초안 입력 컴포넌트
  CoverageResult.jsx      # Coverage 결과 표시
  QAWizard.jsx            # Q&A 위저드
  DefinitionPreview.jsx   # 문서 미리보기
  AIReviewPanel.jsx       # AI 검수 패널
  FinalDefinitionView.jsx # 최종본 뷰
  TestCasesTable.jsx      # 테스트케이스 테이블

lib/
  prisma.js               # Prisma 클라이언트
  openai.js               # OpenAI API 유틸리티
  qaQuestions.js          # Q&A 질문 및 문서 생성 로직

prisma/
  schema.prisma           # Prisma 스키마

설치 및 실행

1. 의존성 설치

npm install

2. 환경 변수 설정

.env 파일을 생성하고 다음 변수를 설정하세요:

DATABASE_URL="postgresql://user:password@host:5432/database?sslmode=require"
OPENAI_API_KEY="your-openai-api-key-here"

3. 데이터베이스 마이그레이션

npx prisma generate
npx prisma migrate dev --name init

4. 개발 서버 실행

npm run dev

브라우저에서 http://localhost:3000을 열어 확인하세요.

업무 변경 정의서 필수 항목

업무 변경 정의서에는 다음 3가지 항목이 반드시 포함되어야 합니다:

항목 완성 기준
1. 변경 변경 이유 + 목적
2. 변경 내용 Before/After + 변경 지점
3. 영향도 채널 + 기능 + 고객군 + 연동관계
4. 배포/롤백 배포 시점 + 롤백 기준·방식
5. 리스크 위험 1~2개 + 대응 1줄
6. 운영 모니터링 지표 + 기간 + 조치

참고: 이 필수 항목들은 Coverage 분석, Q&A 보완, AI 검수 단계에서 우선순위로 체크되며, 중복 내용은 제외 가능합니다.

주요 기능

1. 초안 입력 및 Coverage 분석

  • 시스템 유형 선택 (N코어, N디지털, N단위, 웹컨텐츠, 프로프레임 4.0, sol-git, 단위)
  • 제목, 변경 유형, 초안 내용 입력
  • 변경 유형별 자동 템플릿 제공
  • 필수 항목 실시간 체크 (3초마다)
  • AI가 카테고리별 Coverage 점수(0~2) 분석

2. Q&A 보완

  • Coverage 점수 기반 동적 질문 생성
  • 점수 0: 전체 질문, 점수 1: 보완형 질문, 점수 2: 스킵
  • 실시간 문서 미리보기

3. AI 검수

  • 문서 초안(v0) 검수
  • 누락 항목, 리스크, 개선 제안 생성
  • 제안 자동 반영 기능

4. 최종본 확정

  • 사용자 수정 후 최종본(v1) 확정

5. 테스트케이스 자동 생성

  • 최종본 기반 테스트케이스 JSON 생성
  • CSV 다운로드 기능

배포

Vercel 배포

  1. GitHub에 프로젝트 푸시
  2. Vercel에 프로젝트 연결
  3. 환경 변수 설정:
    • DATABASE_URL
    • OPENAI_API_KEY
  4. 배포 완료

주의사항

  • 모든 파일은 JavaScript(.js/.jsx)로 작성되어 있으며 TypeScript는 사용하지 않습니다.
  • OpenAI API 키가 필요합니다.
  • PostgreSQL 데이터베이스(Neon 권장)가 필요합니다.

라이선스

MIT

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published