소개
이직을 하게되면서 프로젝트를 받고 분석하게 되었다. 현재 개발문서가 정리된 것이 없고 스타트업이다보니 개발문서가 정리되어 있지 않음. 개발 문서를 정리하면서 프로젝트에 적응하는 것이 필요.
(내용 입력)
진행 방법
cursor를 사용하여 todo리스트를 바탕으로 문서 하나씩 정리하도록 요청
문서 구조 설계
[ ] 프로젝트 개요 문서 (overview.md)
[ ] 시스템 아키텍처 문서 (architecture.md)
[ ] 데이터 흐름도 문서 (data-flow.md)
[ ] API 명세서 (api-spec.md)
[ ] 데이터 포맷 문서 (data-format.md)
[ ] 개념 정리 문서 (concepts.md)
[ ] 개발 가이드 (development-guide.md)
문서 작성 세부 계획
[ ] 각 문서의 목차 구조 설계
[ ] 다이어그램이 필요한 부분 식별
[ ] 코드 예제가 필요한 부분 식별
[ ] 초등학생도 이해할 수 있는 설명 방식 기획
문서 작성
[ ] overview.md 작성
프로젝트 소개
개발 목적
주요 기능
사용 기술 스택
[ ] architecture.md 작성
시스템 구성도
컴포넌트 설명
데이터베이스 구조
[ ] data-flow.md 작성
데이터 수집부터 저장까지의 흐름
각 단계별 처리 과정
에러 처리 방식
[ ] api-spec.md 작성
API 엔드포인트 목록
요청/응답 형식
인증 방식
[ ] data-format.md 작성
데이터베이스 스키마
JSON 데이터 구조
데이터 타입 정의
[ ] concepts.md 작성
BLE 통신 개념
생체신호 데이터 설명
데이터베이스 개념
[ ] development-guide.md 작성
개발 환경 설정
실행 방법
테스트 방법
문서 검증
[ ] 각 문서의 기술적 정확성 검증
[ ] 초등학생 수준의 이해도 테스트
[ ] 문서 간 일관성 검증
[ ] 다이어그램과 설명의 일치성 검증
문서 배포 준비
[ ] 마크다운 파일들을 HTML로 변환
[ ] 다이어그램 이미지 최적화
[ ] 문서 간 링크 연결
[ ] 목차 자동 생성결과와 배운 점
총 7개의 문서로 정리 완료
Adobe Adobe Adobe Adobe의 Boxor 컨트롤러 스크린 샷
프로젝트를 분석하라고 해도 구현되어 있지 않은데 적어 놓는 데이터들이 있었음.
직접 문서를 확인하고 재확인하는 과정이 필요함.
추가적으로 실제 코드를 첨삭해 달라고 하는 것도 검증하는 방법이 될 것 같음.
추가 작업내용
pyreverse와 pylint,graphviz를 활용해서 다이어그램을 간단히 그려 관계도를 확인할 수 있다고 함.
