개요

최초 작업을 시작할 때 필요한 프롬프트입니다.

간략한 요구사항을 바탕으로 코딩 작업을 위한 구체적인 작업계획서를 만드는 것이 목표입니다.

관련 문서: 개발자에게 유용한 AI 프롬프트 - 작업계획서 작성 후 코드 구현 단계 참고

작성 Tips

• 작업을 위한 배경지식이 필요한 경우 그 배경지식용 문서마저도 AI 로 작성이 가능하다.
• 작업계획서를 아무리 잘 작성하더라도 부족하거나 모호한 부분이 있을 수 있다.
  • 중간중간 부족한 내용이 있으면 나에게 질문하라고 하면 질문을 할것이다.
  • 질문에 성의껏 답해주면서 답변내용을 포함하여 작업계획서를 업데이트 해달라고 하면 더욱 명료한 작업계획서가 만들어진다.
• 작업계획서에 살을 덧붙이다보면 내용에 중복이 생기거나 너무 길어져서 검토하기가 힘들어진다.
  • 이럴때는 아예 새로운 파일에 기존에 작성하던 작업계획서 파일을 멘션하여 핵심만 다시 정리해달라고 요청해보자.

사용법

1단계: 최초 job_spec 파일 생성

작업 요구사항을 간단히 정리한 파일을 생성합니다. (예: BE-1234.md, my_job_spec.md)

2단계: 작업계획서 생성 요청

아래 프롬프트를 사용하여 작업계획서를 생성합니다.

@my_job_spec.md 의 작업 요건을 파악한뒤, 작업계획서를 동일한 파일에 아래쪽에 이어서 작성을 해줘
작업계획서 작성 시, 아래내용을 참고해줘

참고사항
- 내용에 모호하거나 설명이 부족한 부분이 있으면 나에게 질문에 번호를 붙여서 질문할 것.
  - 선택지 제공이 가능한 질문의 경우 답변도 번호로 골라서 할수 있도록 질문할 것.
- 작업을 단계별로 진행할때 문제없이 참고할 수 있는선에서 가장 간략하게 작성할 것. (너무 길면 검토가 어려움)
- 과도한 상세화 금지: 코드 레벨의 상세한 스펙은 구현 단계에서 결정
- 단계별 구분 명확히: 각 단계가 독립적으로 검토 가능하도록
- 관련 파일/모듈 명시: 작업 범위를 명확히 하기 위해
- 작업계획서는 다음 구조로 작성할 것:
  - 작업 개요
  - 작업 단계 (단계별로 명확히 구분)
  - DB 변경사항 (DDL, DML)
  - 관련 파일/모듈
  - 주의사항 또는 고려사항

3단계: 질문 답변 및 업데이트

AI가 질문을 하면 성의껏 답변하고, 답변 내용을 포함하여 작업계획서를 업데이트해달라고 요청합니다.

위 질문에 대한 답변:
1. [답변]
2. [답변]
...

답변 내용을 반영하여 작업계획서를 업데이트해줘

4단계: 작업계획서 검토 및 정리

작업계획서가 너무 길어지거나 중복이 생기면 핵심만 다시 정리합니다.

@my_job_spec.md 파일의 작업계획서를 참고하여
핵심 내용만 간략하게 정리한 새로운 작업계획서를 작성해줘
불필요한 중복이나 장황한 설명은 제거하고, 실제 작업에 필요한 핵심만 남겨줘

예시

예시 1: 기능 추가 작업

최초 job_spec 파일 내용:

# CMS 다운로드 기능에 Product AA 코드, BB 코드 컬럼 추가

## 요구사항

- 아래 2개 CMS 화면의 다운로드 기능에 AA 코드, BB 코드 컬럼 추가 필요
- 화면1: 주문 > 주문 내역
  - 주문별 내역 다운로드
  - 주문상품별 내역 다운로드
- 화면2: 반품 > 슈퍼반품 관리
  - 신청건별 다운로드
  - 신청상품별 다운로드

## 관련 endpoints

- GET /cms/super-returns/request-download
- GET /cms/super-returns/download
- GET /orders/download?data_type=ORDER
- GET /orders/download?data_type=ITEM

예시 2: 버그 수정 작업

# 주문 취소 시 재고 복구 로직 오류 수정

## 문제 상황

- 주문 취소 시 일부 상품의 재고가 복구되지 않는 현상 발생
- 특정 조건에서만 발생하는 것으로 보임

## 관련 파일

- apps/orders/services/cancel_service.py
- apps/inventory/services/stock_service.py

## 재현 조건

- 주문 상태: 결제 완료 → 취소 요청
- 상품 타입: 일부 상품만 재고 미복구

작업계획서 활용 (=코드 구현 요청)

• 작업 중 요구사항 변경 시 → 작업계획서를 먼저 업데이트한 후 코드 수정
• 복잡한 작업의 경우 → 작업계획서를 여러 단계로 나누어 순차적으로 진행
• 작업계획서가 없으면 2번째줄부터 복사하여 사용하면됨. 하지만 작업계획서를 따로 만든뒤 진행하는것을 추천

@BE-1234.md  의 작업계획서를 바탕으로

이제 단계를 나누어 실제 코드 구현에 들어가보자
단계별로 수정할 내용을 간략하게 보여주면 내가 각각에 대해 컨펌 후 진행하라고 알려줄게

단계별 코드 구현 진행 시, 아래내용을 참고해줘
- 주요 작업 관심사 이외 다른 불필요한 개선이나 기능은 추가하지말고 최소한의 코드만 작성해줘
- 되도록 단계별 코드 수정을 약 100줄 내외로 조절해주면 좋겠어 (내가 리뷰하기 편하도록)
- 코드작성이 완료된 이후, 개선이나 확인이 필요한 부분이 있으면 바로 알려줘