본문 바로가기
토이 프로젝트

[토이프로젝트] 1. 프로젝트 - 문서화 = 0 (프로토타입, API명세서, WBS, 이슈관리)

by img 2022. 3. 15.

우선 어떤 서비스를 개발할지는 정해졌지만, 큰 틀만 정해졌을 뿐 다른 것들은 하나도 정해진 것이 없어서, 문서화를 좀 시키기로 했다.  이 토이프로젝트는 프론트엔드1명, 백엔드 1명이 같이 했기때문에 엄청나게 자세한 문서들을 만들 필요는 없었고, 그래도 원활한 진행을 위해 최소한의 문서는 필요했다. 그래서 다음과 같은 문서들을 만들었다. 

1. 프로토타입

디자이너 없이 사이드 프로젝트를 진행하면서 항상 느꼈던 문제점이, 항상 디자인에 너무 많은 시간을 쏟는다는 것이었다. 디자인에 한번 꽂히기 시작하면 다른 프로그래밍을 할 시간을 많이 빼앗기기때문에 이번에는 전체적인 큰 틀만 잡고 기능을 위주로 빠르게 진행하기로 했다. 그래서 카카오 오븐(https://ovenapp.io/)이라는 툴을 사용해서 중요한 페이지의 레이아웃만 빠르게 잡았고, 그것을 토대로 살을 붙여나가기로 했다.

이런식으로 전체적인 틀을 잡아놓으니까 처음부터 레이아웃을 엎었다가 다시 만드는 일도 없고, 디자인에는 큰 신경을 쓰지 않아도 돼서 빠르게 진행됐다. 

2. API 및 테이블 명세서

백엔드와 프론트엔드를 따로 작업하기때문에, 어디까지 API작업이 완료 됐고, 어디가 아직 완료됐는지 알 수가 없었다. 그래서 노션으로 API명세서를 만들어서 체크표시로 완료여부를 표시했고, 나(프론트엔드)는 완료표시가 있는 API에만 Request 테스트를 하면 됐다. 그리고 명세서에 데이터 예시를 같이 넣었기때문에, 혹시 백엔드가 작업이 덜 되었더라도 프론트엔드에서 가짜데이터를 예시처럼 똑같이 만들어서 테스트할 수 있었다.

 

3. WBS (Work Breakdown Structure) 

스케쥴관리와 업무진행도 체크를 위해 구글 스프레드시트로 WBS도 만들었는데, 매주 주말마다 스터디에서 만나기때문에, 기준을 한주로 잡아서 업무를 나누었다. 한주동안 각자 퇴근후에 작업을 하고 주말 스터디에서 진행상황을 체크하는 방식으로 했다. 

4. 이슈관리

그리고 WBS와 같이 구글 스프레드시트에 생각나는 이슈가 있을때마다 이슈관리 테이블에 적어서 공유해두고, 급한 건은 디스코드나 구글미트로, 급하지 않은 건은 주말 스터디때 그 이슈에 대해서 얘기해보는 시간을 가지면서 이슈관리를 했다. 그리고 해결이 된 이슈는 빨간색으로 처리!

 

댓글