5. 문서화 잘하기
-
템플릿이 없다면 템플릿을 만들자.
- 작성자 / 작성일자 / 작성 이유 / 이전 문서 / 참고 문서 등등
-
프론트엔드 개발자에게 주는 문서라면 아래와 같은 사항들을 포함하자
- 문서 작성 이유
- 해결해야 하는 문제 + 그 문제의 어려운 포인트
- 내가 생각한 해법들 , 각 해법들의 장점과 단점
- 그 해법들 중에 채택하고자 하는 방법과 이유
- 그래서 코드는 어떤식으로?
- 알고있지만 해결하지 않은 문제 (앞으로 개선점)
- 구체적으로 의견을 받고 싶은 포인트
-
백엔드 개발자에게 주는 문서라면 아래와 같은 사항을 포함하자. (아마도 API 명세 드래프트일듯)
- 프론트에서 필요한 데이터
- 프로퍼티명은 이런식으로 주면 좋아요.
-
타직군에게 주는 문서라면 아래와 같은 사항을 포함하자. (아마도 왜 개발안되는지..이유일듯)
- 일정을 미루려는 이유
- 개발적으로 어려운 이유
- 만약에 개발한다면 예상 스토리포인트
문서는 작성이후 반드시 리뷰 받기