Skip to content
kimsungwon edited this page Apr 12, 2024 · 13 revisions

Mr.C 위키 페이지에 오신 것을 환영합니다. 위키에는 프로젝트의 API, 서비스 디자인과 아키텍처, 운영 및 정책, 그리고 엔지니어링과 관련된 문서들을 정리한 내용을 확인할 수 있습니다.

Wiki pages

APIs

  • API Overview: 프로젝트에서 제공하는 전체 API 엔드포인트 목록 및 스펙을 간단하게 정리한 문서입니다.
  • Auth, User, Review, Comment: 각 도메인별 API 엔드포인트와 사용 방법 등을 상세히 기술한 문서입니다.

Service Design and Architecture

  • ERD: 데이터베이스 스키마의 엔티티 관계를 시각적으로 표현한 다이어그램 문서입니다.
  • Sequence Diagrams: 주요 기능의 시퀀스를 다이어그램으로 표현한 문서입니다.
  • Token: 서비스에서 정의한 토큰에 대한 데이터 정의를 기록한 문서입니다.
  • Access Level: 서비스에서 정의한 인가 정책과 관련된 데이터 정의를 기록한 문서입니다.

Operation and Policy

Engineering

  • Development Guidelines: 프로젝트 개발에 필요한 규칙과 지침을 담은 문서입니다. Git Flow, 커밋 메시지 작성법, 주로 사용하는 편집기, 프로젝트 워크스페이스 설정 방법 및 Pull Request 규칙을 포함합니다
  • PoC: 개발 초기에 사용할 패키지 및 설계 방식에 대해 비교한 내용을 정리한 문서입니다.
  • Trouble Shooting: 프로젝트 개발 과정에서 직면했던 다양한 기술적 이슈와 해결 과정을 정리한 문서입니다. 라이브러리 및 기능 개선, 에러 처리 및 통합, ORM 클라이언트 관련 이슈, 테스트 및 데이터베이스 관련 문제, 시스템 안정성 등 다양한 주제를 다루고 있어, 유사한 문제에 직면한 개발자들에게 참고가 될 수 있습니다.
Clone this wiki locally