Skip to content

Restructure doc/architecture based on the current code #522

Description

@youngtaekiim

Background / 배경

Korean

현재 doc/architecture 내 문서들은 과거 기준으로 작성되어, 최신 모듈 구조/데이터 흐름/인터페이스와 차이가 발생하고 있습니다.
이로 인해 신규 참여자 온보딩, 설계 리뷰, 후속 이슈 정의 과정에서 혼선이 발생하며, 문서 신뢰도도 저하된 상태입니다.
현행 구현 기준으로 설계 결과물을 전면 재구성하여, 문서와 코드 간 정합성을 확보할 필요가 있습니다.

English

Current documents in doc/architecture were written based on an older architecture and now differ from the latest module structure, data flow, and interfaces.
This causes confusion in onboarding, design reviews, and follow-up issue planning, reducing documentation reliability.
A full restructuring is needed to realign design outputs with the current implementation.

Objective / 목표

Korean

doc/architecture 폴더를 현재 코드 구조 기준으로 재구성하고, 핵심 설계 산출물을 최신 상태로 정비합니다.

범위는 다음을 포함합니다.

  • 기존 문서의 최신 코드 대비 불일치 항목 식별
  • 문서 구조(목차/분류) 재설계
  • 핵심 아키텍처 문서(구조도, 흐름도, 인터페이스 설명) 업데이트
  • 문서 간 중복/충돌 정리 및 참조 체계 정비

English

Restructure doc/architecture based on the current code structure and refresh core architecture deliverables.

Scope includes:

  • Identifying mismatches between existing docs and the latest codebase
  • Redesigning document structure (indexing/categorization)
  • Updating key architecture docs (structure diagrams, flow diagrams, interface descriptions)
  • Resolving duplication/conflicts and improving cross-document references

Tasks / 수행 내용

  • doc/architecture 내 기존 문서 인벤토리 작성
  • 현재 코드 기준 불일치/obsolete 항목 분석
  • 문서 재구성 원칙 정의 (폴더 구조, 파일 네이밍, 문서 템플릿)
  • 핵심 설계 문서 재작성 또는 분할/통합
    • 시스템 구성도
    • 주요 데이터/제어 흐름도
    • 컴포넌트 간 인터페이스 정의
  • 문서 간 링크/참조 정비 및 중복 제거
  • 결과물 리뷰 체크리스트 작성

  • Build an inventory of existing documents in doc/architecture
  • Analyze outdated or mismatched content against the current codebase
  • Define restructuring principles (folder layout, file naming, document template)
  • Rewrite or reorganize core architecture documents
    • System structure diagram
    • Major data/control flow diagrams
    • Inter-component interface definitions
  • Clean up links/references and remove duplicated content
  • Create a review checklist for final deliverables

Acceptance Criteria / 완료 기준

Korean

  • doc/architecture 문서 구조가 재정의되고 일관된 기준으로 정리됨
  • 주요 설계 문서가 현재 코드와 정합성을 갖도록 업데이트됨
  • obsolete 문서/중복 내용이 정리되고 참조 경로가 정상화됨
  • 결과물이 후속 구현/리팩터링 이슈의 입력으로 활용 가능한 수준으로 작성됨

English

  • The doc/architecture document structure is redefined with consistent organization rules
  • Key architecture docs are updated to align with the current codebase
  • Obsolete/duplicated content is cleaned up and references are normalized
  • The output is detailed enough to serve as input for follow-up implementation/refactoring issues

Out of Scope / 제외 범위

Korean

본 이슈에서는 아래 항목을 다루지 않습니다.

  • 실제 코드 리팩터링/기능 변경
  • 신규 기능 설계의 상세 구현 명세 작성
  • 런타임 성능 측정 및 튜닝 작업
  • 운영 환경 배포/검증 절차 변경

English

The following items are out of scope for this issue.

  • Actual code refactoring or feature changes
  • Detailed implementation specs for new features
  • Runtime performance benchmarking/tuning work
  • Deployment/validation process changes in production environments

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status
    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions