프로젝트

📚 블로기 프로젝트 개발 문서 정리

Chansman 2025. 7. 18. 10:42

📚 블로기 프로젝트 개발 문서 정리

✅ 1. Frontend 문서 (FE)

문서명설명
1. 요구사항 정의서 - 사용자의 시각에서 작성
- 어떤 기능을 제공할 것인지 정리
- 사용자 시나리오 포함
2. 와이어프레임 - Canva 코드 사용 가능
- 기능 배치, 메뉴 구성, 버튼 위치 등 시각 설계
- Figma 기반 UI/UX 설계 포함
3. 플로우차트 (Flow Chart) - 주요 노드(화면), 경로, 조건 분기 등을 시각화
- ex. 로그인 → 홈 → 게시물 등록 → 에디터 화면
4. 화면 정의서 - 각 화면에서 입력/출력 요소 정의
- 버튼 동작, 컴포넌트 구성
- 예외처리(에러 메시지, 유효성 검증 등) 포함
 

✅ 2. Backend 문서 (BE)

문서명설명
1. ERD (Entity Relationship Diagram) - 테이블 구조 및 관계 시각화
- ERDCloud 등을 사용해 정리
2. 테이블 명세서 - ERD 기반으로 각 테이블의 컬럼, 타입, NULL 여부, 제약조건 등을 문서화
- 각 필드의 입력 규칙 및 제약사항 포함
3. API 명세서 - 각 엔드포인트 별로 구성:
→ Endpoint URL
→ HTTP Method
→ Request Body / Query Params
→ Response 형식
→ 상태코드 (200, 400 등)
- 형식 통일 필수 (ex. snake_case / camelCase)
 

🔧 추가 고려사항

  • TDD(Test Driven Development): 테스트 코드 기반 개발 권장
  • Python 프로젝트라면: pytest or unittest 사용 → 자동화 테스트 문서로 연계

🛠️ 3. 트러블슈팅 & 기술 스택 정리

항목설명
외부 AI API 연동 - Gemini (Google AI Studio, Free Tier)
- OpenAI GPT (신용카드 등록 시 $5 크레딧)
- 사용 목적: 블로그 자동생성, 요약, 키워드 추출
WebRTC - 실시간 스트리밍, 저지연 영상 전송 기술
- 사용 시 고려 요소: STUN/TURN 서버, 시그널링 방식, 브라우저 호환성
사진 학습 기능 - 이미지 업로드 기반 학습 AI?
- TensorFlow / PyTorch / Teachable Machine 등 고려
챗봇 개발 - 자연어 처리(NLP) 기반 자동응대
- 예시: Rasa, Dialogflow, GPT API 연동
- FAQ 자동응답, 블로그 작성 보조 등
 

📌 전체 문서 작성 순서 예시 (기획 → 설계 → 구현 → 테스트)

  1. [기획]
    • 요구사항 정의서
    • 와이어프레임 / 화면흐름도
  2. [설계]
    • 플로우차트
    • ERD
    • 화면 정의서
    • 테이블 명세서
    • API 명세서
  3. [구현 및 검증]
    • 개발
    • 테스트 코드
    • 외부 API 연동 / 에러 트러블슈팅
    • 챗봇/NLP 기능 적용