D+44 [Project] 프로그램 개발 산출물 작성 방법

ㅇ 일 자 : 2026년 6월 10일(수) 

ㅇ 목 표 : 프로그램 산출물에 대한 이해와 작성 방법 

 

 프로그램 산출물 & 작성방법

1. Project  산출물

 

1.1. 개발 산출물은?

• 프로젝트는 사용자 중심에서 생각하고 사용자가 사용 가능한 프로그램을 개발해야 한다. 
• 프로그램 개발 산출물은 프로젝트의 '설계도'이자 '설명서'이므로, 제3자가 보아도 이해할 수 있도록 명확하고 구체적으로 작성

 

2. 개발 산출물 및 작성방법

2.1. 프로그램 개발 계획서

• 프로젝트 개요 : 개발 목적과 기대 효과를 한 페이지로 요약
• 개발 범위 : 개발할 프로그램의 기능과 포함되지 않는 범위 명확화
• 요구사항 정의 : 사용자가 원하는 기능과 시스템 성능 요건을 구체화
• 시스템 설계 : 아키텍처, 데이터베이스 모델링(ERD), UI/UX 화면 설계서 포함
• 일정 계획 : 작업 분할 구조도(WBS)를 활용해 세부 마일스톤 작성
• 인력 및 예산 : 투입 인력의 역할과 개발 비용을 산정
• 위험 관리 : 예상되는 기술적 문제와 일정 지연에 대한 대응책 수립

2.2. 요구사항 정의서 (Requirement Specification) : 프로젝트의 출발점으로, "무엇을 만들 것인가"

• 작성 방법 : 고객의 모호한 요구를 기술적인 언어로 명확히 바꾸어 작성, 모호한 표현(예: "빠르게 처리된다", "예쁘게 디자인한다") 대신 정량적인 수치와 명확한 동작을 적어야 한다.
• 필수 항목 : 요구사항 ID, 요구사항 명칭, 분류(기능/비기능), 상세 설명, 우선순위(상/중/하), 요청자

2.3. 화면 설계서 / 스토리보드 (Storyboard) : UI/UX 디자이너와 개발자가 화면을 어떻게 구현할지 합의하는 문서

• 작성 방법: 화면 디자인 영역(와이어프레임)과 설명 영역(Description)을 분리, 버튼을 눌렀을 때의 이동 경로, 예외 처리(데이터가 없을 때 등)에 대한 동작을 빠짐없이 적어야 한다.
• 필수 항목: 화면 ID, 화면명, UI 와이어프레임, 기능 및 디스크립션(인터랙션 정의), 이동할 화면(링크)

2.4. 데이터베이스 설계서 및 ERD (Database Design) : 데이터가 어떻게 저장되고 관리되는지 구조를 보여주는 문서

• 작성 방법: 개념적 설계에서 시작해 물리적 설계로 발전시킨다. 테이블 간의 관계(1:1, 1:N)를 명확히 선으로 연결하고, 데이터 타입(문자, 숫자 등)과 길이를 정확히 지정한다.
• 필수 항목: 엔티티(테이블)명, 속성(컬럼)명, 데이터 타입 및 길이, PK(기본키)/FK(외래키) 여부, Null 허용 여부

2.5. API 명세서 (API Specification) : 프론트엔드와 백엔드가 데이터를 주고받는 규칙을 정한 문서

• 작성 방법: 주소(URL)와 요청 방식을 명시하고, 보낼 데이터(Request)와 받을 데이터(Response)의 형식을 JSON 형태로 예시를 들어 작성, 성공할 때와 실패할 때의 응답 코드를 모두 적어주어야 혼선이 없다.
• 필수 항목: API ID/이름, HTTP Method(GET, POST 등), URL 경로, 요청 파라미터, 응답 데이터(성공/실패 예시), HTTP 상태 코드.

2.6. 테스트 시나리오 및 결과서 (Test Case) : 개발된 프로그램이 기획대로 잘 작동하는지 확인하는 문서

• 작성 방법: '누가, 어떤 화면에서, 무엇을 했을 때, 어떤 결과가 나와야 한다'를 하나의 행으로 작성, 정상적인 입력뿐만 아니라 잘못된 값을 넣었을 때 오류 메시지가 잘 뜨는지(비정상 케이스)도 반드시 테스트해야 한다.
• 필수 항목: 테스트 ID, 테스트 경로(화면), 테스트 조건/절차, 기대 결과, 실제 결과, 통과 여부(Pass/Fail), 결함 내용

2.7. 사용자 및 관리자 매뉴얼 (Manual) : 시스템을 처음 쓰는 사람이 보고 따라 할 수 있는 안내서

• 작성 방법: 전문 용어는 최대한 줄이고 구어체로 쉽게 작성한다. 모든 과정은 실제 화면 캡처 이미지를 첨부하고, 중요 버튼이나 입력창은 빨간색 네모나 화살표로 강조 표시를 해주는 것이 좋다.
• 필수 항목: 시스템 개요, 로그인 방법, 주요 기능별 이용 프로세스(화면 캡처 포함), 자주 묻는 질문(FAQ) 및 문제 해결 가이드

---

 

1. 프로그램 소스코드 작성시 참고사항

1.1. CRUD : 생성(Create), 읽기(Read), 수정(Update), 삭제(Delete)

컴퓨터 소프트웨어와 데이터베이스 관리 시스템에서 데이터를 처리하는 네 가지 기본 기능인 생성(Create), 읽기(Read), 수정(Update), 삭제(Delete)의 약어, 거의 모든 웹 애플리케이션과 REST API 설계에서 데이터를 효율적으로 관리하기 위한 핵심 뼈대로 활용된다. CRUD 기능의 핵심 개념각 글자는 시스템에서 데이터가 수행하는 역할을 명확히 나타낸다. 

• C (Create, 생성): 데이터를 새로 만드는 기능
• R (Read, 읽기): 기존 데이터를 조회하거나 검색하는 기능
• U (Update, 수정): 기존 데이터의 내용을 변경하는 기능
• D (Delete, 삭제): 불필요한 데이터를 제거하는 기능

(예 시)

• 게시판 (게시글 관리)Create : 새 글 작성하기
• Read : 작성된 글 목록 보기, 상세 내용 보기
• Update : 작성한 글 내용 수정하기
• Delete : 불필요한 글 지우기
• 쇼핑몰 (장바구니 시스템)Create : 장바구니에 상품 담기
• Read : 장바구니에 담긴 상품 목록 확인하기
• Update : 상품의 수량 변경하기
• Delete : 장바구니에서 상품 빼기
• SNS (프로필 관리)Create : 회원가입, 새 프로필 등록
• Read : 내 프로필 페이지 보기
• Update : 프로필 사진 및 상태 메시지 변경
• Delete : 회원탈퇴 개발 환경에서의 CRUD 구현프로그래밍에서 CRUD는 데이터베이스의 영구 저장소와 상호작용하기 위한 F-Lab 개발 인사이트의 중요한 설계 지침
• SQL (데이터베이스) : INSERT, SELECT, UPDATE, DELETE 명령어를 사용
• HTTP (웹 API) : POST, GET, PUT/PATCH, DELETE 메서드를 사용, 게시판과 데이터베이스를 활용하여 CRUD 기능을 실제로 구현하는 과정.  끝.