4.5 애플리케이션 개발 준비

[jongfeel]

4.5 애플리케이션 개발 준비

4.5.1 개발자용 문서 정비

애플리케이션 기능을 담당하는 개발자가 아키텍처의 원칙을 이해하고, 애플리케 이션 기반이 제공하는 공통 기능을 활용한 구현 방법을 빠르게 익혀 합류 초반부터 자기 기량을 충분히 발휘할 수 있도록 하려면 각종 개발 문서를 미리 준비해 둘 필요가 있습니다.

• 개발 규약: 코딩, 명명, 구성 관리
• 절차서: 환경 구축, 도구 이용
• 구현 참고자료: 가이드라인, 튜토리얼

4.5.2 개발 규약

개발 규약은 소스 코드를 포함한 소프트웨어 자산의 품질을 유지하기 위해 프로 젝트 전반에서 공통적으로 따라야 할 규칙을 정리한 문서입니다.

코딩 규약

코딩 규약coding conventions은 들여쓰기 폭, 괄호 배치 위치 등 소스 코드의 스타일을 정의한 규칙입니다.

코딩 규약을 처음부터 직접 작성하려면 많은 노력이 들기 때문에 조직이나 업계 에서 이미 마련한 표준 코딩 규약이 있다면 이를 활용하는 것이 좋습니다.

명명 규약

명명 규약naming conventions은 소스 코드의 파일명, 네임스페이스명, 클래스명, 메서드명, 변수명 등의 이름을 정할 때 일관성을 부여하기 위한 규칙으로, 코딩 규약 안에 함께 정리되기도 합니다.

기타

소스 코드 구성 관리는 일반적으로 구성 관리 규약으로 정리합니다.

메시지 식별 코드 체계나 메시지 문구 작성 방식을 메시지 규약으로 정리하는 것이 좋습니다.
또한 테이블이나 뷰 같은 데이터 베이스 객체의 명명 규약, 공통 열 정의, 대리키와 복합키 사용 방침 등은 데이터 베이스 설계 규약으로 정리합니다.

4.5.3 절차서

절차서는 구현 과정에서 반복적으로 발생하는 작업 절차를 문서로 정리하여 공유 함으로써 개발자와 팀의 업무 효율을 높이는 것을 목적으로 합니다.

일련의 설치 및 설정 과정을 스크린샷과 함께 정리한 개발 환경 구축 절차서는 미리 문서로 작성해 준비해 둡니다.
이외에도 개발 과정에서 사용하는 도구가 있다면, 필요에 따라 도구 사용 절차서를 작성하는 것이 좋습니다.

COLUMN 클라우드 개발 환경

클라우드 개발 환경을 이용하면 로컬 머신에 일일이 개발 환경을 설정하는 수고를 줄일 수 있으며, 개발자마다 환경이 달라 발생하는 문제(OS 종류나 버전, 설치된 소프트웨어, 각종 설정 등)도 방지할 수 있습니다.

예를 들어, 2022년에 출시된 GitHub Codespaces가 있습니다.

4.5.4 구현 참고 자료

구현 가이드라인

• 상속할 부모 클래스 및 구현해야 할 인터페이스 정보
• 부모 클래스나 인터페이스의 추상 메서드 구현 방법
• 애플리케이션 기반의 공통 기능 활용 방법
• 유틸리티 사용 방법
• 외부 라이브러리 사용 방법
• 테스트 코드 작성 방법

튜토리얼

오픈소스 소프트웨어의 공식 사이트에는 API 사양서 같은 문서 외에 튜토리얼이 함께 제공되는 경우가 있습니다.

새롭게 합류한 개발자는 개발 환경 구축 절차서에 따라 로컬 머신의 환경을 설정한 뒤 튜토리얼을 진행합니다.