Skip to content

[ Docs ] 기능별 설계 문서 정리 및 아키텍처 다이어그램 #75

Description

@RosieOh

🧑‍💻 오늘의 개발하면서 생긴 크고 작은 이슈사항을 기록해주세요

💚 어떤 기능인가요?

#65 ~ #74 에서 만든 기능과 고친 문제들이 커밋 메시지와 이슈 본문에만 흩어져 있습니다.
새로 합류하는 사람이 "왜 이렇게 만들었는지" 를 알려면 51개 커밋을 역순으로 읽어야 합니다.

특히 남겨야 하는 판단들

코드만 봐서는 알 수 없고, 잘못 건드리면 되돌아오는 것들입니다.

  • 빈자리 알림은 "있다" 가 아니라 "늘었다" 로 판단한다 — 계속 자리가 있는 시설을 매일 알리면 스팸
  • 소득 미입력을 탈락으로 처리하지 않는다 — 받을 수 있었던 지원금이 통째로 사라짐
  • 융자를 지원금 총액에 넣지 않는다 — 갚아야 하는 돈은 "받는 돈" 이 아님
  • 표본이 부족하면 확률·통계를 만들어내지 않는다 — 그럴듯한 숫자가 더 위험
  • 빈자리 알림 문구에 "시설 전체 기준" 한계를 밝힌다 — 반이 다르면 헛걸음
  • 마감 알림에 유니크 제약이 필요하다 — Blue/Green 이라 인스턴스가 2대가 됨
  • 테이블명은 대문자 — Linux MariaDB 는 대소문자를 구분
  • 404·403 은 운영 알림을 보내지 않는다 — 진짜 장애가 소음에 묻힘

문서 구조

기능별로 나누고, 각 문서에 "문제 → 판단 → 근거 → 미해결" 을 담습니다.
아키텍처는 Mermaid 로 md 안에 넣고, 편집 가능한 draw.io 원본도 함께 둡니다.

✅ To Dos

  • docs 색인 및 구조 설계
  • 아키텍처 문서 (Mermaid) + draw.io 원본
  • 기능 문서 7종 (공공데이터·지원금·시설·알림·지표·개인정보·운영)
  • 품질 문서 2종 (기동 안정화·회귀 방지)
  • 레퍼런스 2종 (마이그레이션·접근제어 매트릭스)
  • 문서에 적은 경로·설정값을 코드와 대조 검증
  • 루트 README 에서 연결

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationdomain:core코어/공통priority:P2일반 우선순위

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions