Skip to content

[발전 방안 제안(Improvement Plan)]: 공공데이터 공통표준 기반 템플릿 DB 네이밍 표준화 및 AI 코딩 에이전트용 규칙 문서 제공 #557

@gjh999

Description

@gjh999

아이디어 요약 (Idea Summary)

AI 코딩 에이전트 활용이 늘어남에 따라, eGovFrame 템플릿의 DB 식별자 네이밍 일관성이 중요해지고 있습니다. 현재 템플릿들은 UPPER FLAT CASE를 사용해 가독성이 낮습니다. 공공데이터포털의 공통표준 단어·도메인·용어를 Markdown 규칙 문서로 정리해 제공하면, AI 에이전트가 코드 생성·수정 시 표준 네이밍을 일관되게 유지할 수 있습니다. 5개 주요 템플릿별로 표준 기반 코드베이스 구축을 단계적으로 제안합니다.


배경 (Background)

최근 AI 코딩 에이전트 활용이 확대되면서, 에이전트가 참조할 일관된 코드 컨벤션과 네이밍 표준의 필요성이 커지고 있습니다. eGovFrame은 Simple Homepage, Portal Site, Enterprise Business, Common Components, 그리고 Boot 기반 Simple Homepage(Backend) 등 기본 템플릿을 제공하고 있어, 이를 표준 네이밍의 기준점으로 삼기 좋습니다.

문제점 (Problem)

현재 템플릿의 테이블·컬럼 식별자는 UPPER FLAT CASE로 작성되어 단어 경계 구분이 어렵고 가독성이 떨어집니다. (길이 제한이 있던 일부 구형 DBMS 환경의 영향으로 보입니다.)

제안 내용 (Proposal)

공공데이터포털(data.go.kr)이 제·개정하는 공통표준 단어·도메인·용어를 기준으로 삼아, 다음 두 가지를 함께 진행할 것을 제안합니다.

  1. 공통표준 규칙 문서 제공 — 공공데이터 공통표준을 Markdown 형식의 네이밍 규칙 문서로 정리하여, AI 코딩 에이전트가 컨텍스트(규칙 파일)로 참조할 수 있게 제공합니다.
  2. 템플릿 DB 스키마 재정비 — 각 템플릿의 DB 스키마를 공통표준 기반으로 재정비합니다.

참고: 공공데이터 공통표준 최신 버전(예: 2025년 11월 기준)을 기반으로 진행하며, 실제 적용 시점의 최신 버전을 확인해 반영합니다.

규칙 파일 (초안)

공통표준을 Markdown으로 정리한 규칙 파일 초안입니다.

구분 파일 링크
표준 단어 word_rule.md https://github.com/gjh999/docs/blob/main/code_convention/word_rule.md
표준 도메인 domain_rule.md https://github.com/gjh999/docs/blob/main/code_convention/domain_rule.md
표준 용어 1 term_rule_1.md https://github.com/gjh999/docs/blob/main/code_convention/term_rule_1.md
표준 용어 2 term_rule_2.md https://github.com/gjh999/docs/blob/main/code_convention/term_rule_2.md
표준 용어 3 term_rule_3.md https://github.com/gjh999/docs/blob/main/code_convention/term_rule_3.md
표준 용어 4 term_rule_4.md https://github.com/gjh999/docs/blob/main/code_convention/term_rule_4.md
표준 용어 (통합) term_rule.md https://github.com/gjh999/docs/blob/main/code_convention/term_rule.md

term_rule.md는 용량이 커서 GitHub에서 표(table)가 아닌 원시(raw) 형태로 표시될 수 있습니다. 분할본인 term_rule_1~term_rule_4를 함께 참고해 주세요.

작업 범위 (Scope)

테이블·컬럼명을 변경하면 연관 소스(매퍼, DAO, VO 등)도 함께 수정해야 하므로 작업량이 큽니다. 따라서 한 번에 전체를 변경하기보다 템플릿별로 나누어 단계적으로 진행할 것을 제안합니다.

  1. Simple Homepage — DB 표준 코드베이스 구축
  2. Portal Site — DB 표준 코드베이스 구축
  3. Enterprise Business — DB 표준 코드베이스 구축
  4. Common Components — DB 표준 코드베이스 구축
  5. Simple Homepage (Backend) — DB 표준 코드베이스 구축
  6. 그외 저장소 소스 — DB 표준 코드베이스 구축

진행 방식 (Suggested Approach)

표준 코드베이스를 기존 저장소에 직접 반영하면 소스 충돌이 발생할 수 있으므로, 다음 방식 중 하나로 진행할 것을 제안합니다.

  1. 개인 저장소 제출 — 작업한 코드베이스를 개인 저장소에 정리하여 올리고, 해당 저장소 링크로 검토를 요청합니다.
  2. 포크 후 Pull Request — 기존 저장소를 개인 계정으로 포크(fork)하여 작업한 뒤, Pull Request로 검토를 요청합니다.

기대 효과 (Expected Benefits)

  • AI 코딩 에이전트가 표준 네이밍을 일관되게 유지하여 코드 생성·수정 품질 향상
  • 공공데이터 공통표준 준수로 공공 시스템 간 데이터 정합성 및 호환성 강화
  • 식별자 가독성 개선으로 유지보수 및 신규 개발자 온보딩 용이

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions