소프트웨어 개발 과정에서는 다양한 문서가 필요합니다. 각 문서는 프로젝트의 요구사항을 정의하고, 개발 및 테스트 과정에서 참고할 수 있도록 체계적으로 정리하는 역할을 합니다. 여기에서는 개발 시 필수적인 주요 문서들의 개념과 역할을 정리해 보겠습니다.
1. 화면정의서
사용자가 실제로 보게 될 UI 화면의 구성과 동작을 정의한 문서입니다.
버튼, 입력 필드, 화면 전환 등의 요소를 포함하며, UX/UI 설계 단계에서 필수적으로 작성됩니다.
주로 PPT로 제작하며 화면 ID, 화면 기능등이 작성되어있습니다.
2. 요구사항 사양서 (Software Requirements Specification, SRS)
프로젝트의 기능 및 비기능 요구사항을 체계적으로 정리한 문서입니다.
사용자가 원하는 기능과 시스템의 제약 조건을 명확히 정의하여, 개발팀과 이해관계자 간의 커뮤니케이션을 원활하게 합니다. 주로 PL, PMO가 결정합니다.
3. 요구사항 정의서
프로젝트에서 반드시 구현해야 할 기능을 구체적으로 정의한 문서입니다.
사용자의 니즈를 분석하여 어떤 기능이 필요한지 상세하게 정리하며, 개발 범위를 확정하는 역할을 합니다.
4. 요구사항 추적서
요구사항이 개발 및 테스트 과정에서 제대로 반영되었는지 추적하는 문서입니다.
각 요구사항이 어떤 기능으로 구현되었는지, 그리고 테스트 결과가 어땠는지 기록하여 프로젝트의 품질을 보장합니다.
5. 개발 표준 정의서
코딩 스타일, 네이밍 규칙, 파일 관리 방식 등 개발 과정에서 준수해야 할 표준을 정리한 문서입니다.
개발자의 코드 품질을 일정하게 유지하고, 협업을 원활하게 하기 위해 필요합니다. 내용이 방대하며 업무 코드, 화면 ID, 처리 코드 등 규칙을 정하는 문서입니다.
6. 산출물 적용 계획표
프로젝트 진행 중 생성되는 모든 산출물(문서, 코드, 테스트 결과 등)을 언제, 어떻게 적용할지 정리한 문서입니다.
개발 일정과 연계하여 산출물을 체계적으로 관리하는 데 도움을 줍니다.
7. 용어사전
프로젝트에서 사용되는 주요 용어와 정의를 정리한 문서입니다.
팀원 간의 용어 해석 차이를 방지하고, 개발 및 문서 작성 시 일관성을 유지하는 역할을 합니다.
8. 도메인 정의서
프로젝트에서 다루는 특정 도메인의 개념과 범위를 정의한 문서입니다.
예를 들어, 금융 시스템을 개발할 경우 ‘계좌’, ‘이체’, ‘잔액’ 등의 개념을 명확하게 정리합니다.
9. 메뉴 구성도
시스템 내에서 제공되는 메뉴의 구조와 계층을 정리한 문서입니다.
사용자가 접근할 수 있는 화면과 기능을 시각적으로 표현하여, UI/UX 설계 및 개발 방향을 잡는 데 도움을 줍니다.
10. 테이블 정의서
데이터베이스에서 사용될 테이블의 구조를 정의한 문서입니다.
각 테이블의 이름, 컬럼, 데이터 타입, 제약 조건 등을 정리하여 DB 설계의 기준을 제공합니다.
11. ERD (Entity-Relationship Diagram, 개체-관계 다이어그램)
데이터베이스의 테이블 간 관계를 시각적으로 표현한 다이어그램입니다.
클래스다이어그램을 활용하여 데이터 흐름을 한눈에 파악할 수 있어, 데이터 모델링과 DB 설계에 필수적으로 사용됩니다.
12. 프로그램 목록
개발해야 할 프로그램(모듈)과 그 기능을 정리한 문서입니다.
각 프로그램의 역할과 담당자를 명확히 하여 개발 진행 상황을 효과적으로 관리할 수 있습니다.
13. 컬럼 정의서
데이터베이스 테이블의 컬럼(속성) 정보를 상세히 정의한 문서입니다.
컬럼명, 데이터 타입, 기본값, 제약 조건 등을 정리하여 데이터 무결성을 유지하는 데 도움을 줍니다.
14. 단위 테스트 수행 보고서 및 시나리오
각 기능별로 단위 테스트를 수행한 결과를 정리한 문서입니다.
테스트 케이스, 테스트 결과, 오류 사항 등을 기록하여, 개발된 기능이 정상적으로 동작하는지 검증합니다.
이 문서들은 프로젝트 진행 과정에서 개발자뿐만 아니라 기획자, 디자이너, QA팀 등 다양한 팀원들이 참고하게 됩니다.
체계적인 문서 관리가 곧 프로젝트의 성공과 직결되므로, 필요에 맞게 정리하고 활용하는 것이 중요합니다!
'개발 > 정리' 카테고리의 다른 글
| delete eslintprettier/prettier 해결방법 (0) | 2025.02.01 |
|---|---|
| Parsing error: No Babel config file detected (0) | 2025.02.01 |
| PMO / PM / PL / PA / PO 개발 프로젝트 역할 정리 (0) | 2025.01.30 |
| DAO(2) (1) | 2021.07.04 |
| DAO (0) | 2021.07.04 |