프로젝트 리뷰 - CLOVA API 활용, 실습 도구 기획 및 개발
1. 완성화면 보러가기
[3. 튜닝데이터로 자신만의 챗봇 소개 페이지 만들기-영상캡처]
2. 개발 기간 및 기여
개발 기간:
- 2023년, 6월 ~ 8월 11일
기여:
- 기획:
- 실습 도구 기획서(요구명세 / 기능명세 / 백엔드 API 명세) 작성
- 이해 관계자에 컨펌 및 내용 전달
- 개발:
- 프론트(메인)
※ 2023년 7~8월 방학특강에서 2개 클래스에 시범적으로 사용. 실사용 유저 테스트까지 통과되었으며, 반응이 좋았음.
3. 프로젝트 제목 및 설명
제목:
- 초등 고학년 ~ 중학생, AI 리터러시 실습 도구
설명:
- 네이버 MOU를 시작으로 CLOVA AI 서비스를 활용하여, AI 학습모델을 코드없이 다뤄보고, AI 서비싱이 가능한 산출물까지 학생이 가져가는 콘텐츠
- src > front: 일반 사용자(학생)가 사용하는 실습도구를 구성하는 소스코드
4. 기술 스택 및 사용된 도구
언어 :
- JavaScript(ES6+): 최신 ECMAScript 표준을 사용한 프로그래밍.
프레임워크 및 도구:
- react: 프레임워크
- react-router-dom: SPA(Single Page Application) 라우팅 관리
- react-redux: 전역 상태 관리
- antd: UI 컴포넌트로 사용
백엔드 통신:
- CLOVA Studio API: CLOVA AI 모델을 사용하기 위한 용도.
- axios: HTTP 클라이언트 라이브러리
- Postman: API 테스팅
5. 다음 프로젝트에서 알아야 할 것들
어떠한 상황 때문에 기획서(요구사항 명세, 기능명세, Backend API 요청항목)를 작성해야 하는 상황이 온다면, 이번에 작성했던 방식으로 진행해보자.
History
아래와 같이 큰 디벨롭 위주로 이력을 작성하도록하자.
요구사항 명세
요구사항 명세에는 사업부, 콘텐츠 팀에서 바라는 산출물의 스토리보드를 요청하도록 하자. 전달받은 스토리보드를 분석하고, 분석한 내용을 아래와 같이 구분하여 차근차근 최대한 빈틈없이 담아내도록 하자.
- 구분: 학습 콘텐츠라 ‘주차’ 단위로 나누었음
- 메뉴명: 개발하게 될 앱
- 요구사항: 위 메뉴에서 제공하게 될 메인 기능
- ★ 설명: 위 요구사항을 달성하기 위해 반드시 필요한 세부 기능들과 그 기능 개발을 위한 정책들을 적는 곳
- 개발 범위 / 필요 여부 / 개발 피드백: (설명 생략)
- 비고: 정책 결정이 필요한 내용 또는 참고 자료, 링크 등을 첨부
기능명세
기능명세만으로 화면을 그려낼 수 있을 정도로 구체적으로 작성한다. 주로 컴포넌트와 필요 데이터등을 있는대로 최대한 작성한다. 그리고 여기서 열심히 작성한 기능명세는 Backend API 요청 항목으로 풀어내어 백엔드 개발자와 편하게 소통할 수 있다.
- 메뉴 / Depth1 / Depth2: (설명 생략)
- 작업 사항: 나는 프론트엔드 메인 개발을 담당했기 때문에, 프론트 개발과 관련된 내용은 생략했다. 나 같은 경우, 주로 필요한 DB의 대략적인 스키마만을 작성했다.
- 구성 요소 & 기능 명세: 구성 요소는 주로 UI를 구성하는 컴포넌트들을 빠짐 없이 작성하고, 각 컴포넌트들의 세부적인 기능을 자세히 작성한다.
- 질문 사항: 나같은 경우 백엔드와 소통을 위한 질문 위주로 작성하였다.
Backend API 요청항목
나에게 있어 요구사항, 기능명세는 Backend API 요청항목 작성을 위한 단계였다. RESTful API 방식으로 작성하며, 각 데이터의 라벨링, type, 필수여부를 작성한다.
댓글남기기