Skip to content

프로젝트 문서화: 클래스 다이어그램 · 매뉴얼 · README - #1

Merged
ThunderVolt45 merged 3 commits into
mainfrom
docs/presentation-documentation
Jun 24, 2026
Merged

프로젝트 문서화: 클래스 다이어그램 · 매뉴얼 · README#1
ThunderVolt45 merged 3 commits into
mainfrom
docs/presentation-documentation

Conversation

@ThunderVolt45

Copy link
Copy Markdown
Owner

개요

프로젝트의 발표/사용을 위한 문서화 작업입니다. 클래스 다이어그램, 매뉴얼, README를 추가·보강했습니다.

변경 사항

📐 클래스 다이어그램 (docs/ClassDiagram.md + docs/class-diagram/)

  • Mermaid 기반 클래스 다이어그램을 클래스(그룹)별 문서로 분리
  • ClassDiagram.md는 인덱스(전체 구조 개요·표기 규약·enum 요약), 상세는 하위 문서로 분리
  • 대상: UGUIWindow, UGUIWindowManager, 상호작용 컴포넌트, Cursor/Log, DoublyLinkedList, Sample, Editor

📖 매뉴얼 (docs/Manual.md + docs/manual/)

  • 사용 가이드 + 설계 설명을 겸한 8개 챕터 (시작하기 → API 레퍼런스)
  • 각 챕터 상단에 섹션 점프 목차 포함
  • 라이프사이클/풀링 흐름을 Mermaid 다이어그램으로 시각화

📝 README 보강

  • 주요 기능, 개발 환경, 시작하기, 문서 링크, 프로젝트 구조, CI/CD, 라이선스 섹션 추가
  • Under Construction 자리표시자 대체

참고

  • 코드 변경 없음. 문서(docs/, README.md)만 추가/수정
  • 한국어 문서 특성상 일부 Mermaid/목차 앵커는 GitHub 렌더링에서 한 번 확인 권장

🤖 Generated with Claude Code

ThunderVolt45 and others added 3 commits June 24, 2026 11:21
Mermaid 기반 클래스 다이어그램을 클래스(그룹)별 문서로 분리하여 작성.
docs/ClassDiagram.md는 인덱스, docs/class-diagram/ 하위에 상세 문서 배치.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
사용 가이드와 설계 설명을 겸한 매뉴얼을 챕터별로 작성.
docs/Manual.md는 인덱스, docs/manual/ 하위에 01~08 챕터 배치.
각 챕터 상단에 섹션 점프 목차 포함.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
주요 기능, 개발 환경, 시작하기, 문서 링크, 프로젝트 구조, CI/CD,
라이선스 섹션을 추가하여 Under Construction 자리표시자를 대체.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@ThunderVolt45
ThunderVolt45 merged commit a04986d into main Jun 24, 2026
2 checks passed
@ThunderVolt45
ThunderVolt45 deleted the docs/presentation-documentation branch June 24, 2026 05:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant