Skip to content

Commit 3dac9de

Browse files
committed
feat: AI Agent 지원 — llms.txt, llms-full.txt, ai-reference 웹 서빙
- llms.txt: 프로젝트 요약 + 50개 AI Reference 링크 - llms-full.txt: 50개 AI Reference 합본 (646KB) - site/ai-reference/: 개별 .md 파일 웹 서빙 - site/.nojekyll: GitHub Pages에서 .md raw 서빙 - README.md: AI Agents 지원 섹션 추가
1 parent cab544e commit 3dac9de

56 files changed

Lines changed: 44781 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -281,4 +281,18 @@ MIT License. 자유롭게 사용하세요.
281281

282282
---
283283

284+
## 🤖 AI Agents 지원
285+
286+
AI 에이전트가 콘텐츠를 효율적으로 소비할 수 있도록 [llms.txt](https://m1zz.github.io/HIGLab/llms.txt) 표준을 지원합니다.
287+
288+
| 엔드포인트 | 설명 |
289+
|-----------|------|
290+
| [`/llms.txt`](https://m1zz.github.io/HIGLab/llms.txt) | 프로젝트 요약 + 50개 AI Reference 링크 |
291+
| [`/llms-full.txt`](https://m1zz.github.io/HIGLab/llms-full.txt) | 50개 AI Reference 합본 (마크다운) |
292+
| [`/ai-reference/*.md`](https://m1zz.github.io/HIGLab/ai-reference/) | 개별 프레임워크 참조 문서 |
293+
294+
> 💡 Claude, GPT, Cursor 등에서 `llms.txt` URL을 제공하면 정확한 iOS 코드 생성이 가능합니다.
295+
296+
---
297+
284298
Made with ❤️ by [개발자리](https://youtube.com/@devjari)

site/.nojekyll

Whitespace-only changes.

site/ai-reference/HOW-TO-USE.md

Lines changed: 225 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,225 @@
1+
# 🤖 AI Reference 사용 가이드
2+
3+
> AI에게 iOS 코드 생성을 요청할 때 이 문서들을 활용하는 방법
4+
5+
---
6+
7+
## 🎯 이 문서가 필요한 이유
8+
9+
AI(Claude, GPT 등)에게 "위젯 만들어줘"라고 하면:
10+
11+
**문서 없이**: 오래된 API 사용, 불완전한 코드, 컴파일 안 됨
12+
**문서 있으면**: 최신 API, 전체 작동 코드, 바로 실행 가능
13+
14+
---
15+
16+
## 📖 사용 방법
17+
18+
### 방법 1: 직접 붙여넣기 (가장 간단)
19+
20+
1. 원하는 문서 열기 (예: `widgets.md`)
21+
2. 전체 내용 복사
22+
3. AI 채팅에 붙여넣고 요청
23+
24+
```
25+
이 문서를 참고해서 할일을 표시하는 위젯을 만들어줘:
26+
27+
[widgets.md 전체 내용 붙여넣기]
28+
```
29+
30+
### 방법 2: GitHub Raw URL 사용
31+
32+
AI에게 URL을 제공:
33+
34+
```
35+
이 문서를 읽고 날씨 위젯을 만들어줘:
36+
https://raw.githubusercontent.com/M1zz/HIGLab/main/ai-reference/widgets.md
37+
```
38+
39+
### 방법 3: Cursor / VS Code에서 사용
40+
41+
1. `ai-reference/` 폴더를 프로젝트에 추가
42+
2. Cursor에서 `@ai-reference/widgets.md` 태그로 참조
43+
3. 또는 `.cursorrules` 파일에 포함
44+
45+
```
46+
# .cursorrules
47+
@ai-reference/widgets.md 를 참고해서 iOS 위젯을 구현합니다.
48+
```
49+
50+
### 방법 4: Claude Projects에 추가
51+
52+
1. Claude.ai > Projects
53+
2. 새 프로젝트 생성
54+
3. Knowledge에 `.md` 파일들 업로드
55+
4. 프로젝트 내에서 자동 참조됨
56+
57+
### 방법 5: GitHub Copilot 컨텍스트
58+
59+
```swift
60+
// @see ai-reference/swiftdata.md
61+
// SwiftData를 사용한 할일 앱을 만들어줘
62+
```
63+
64+
---
65+
66+
## 💬 프롬프트 예시
67+
68+
### 기본 요청
69+
70+
```
71+
widgets.md를 참고해서 주식 시세를 표시하는 위젯을 만들어줘.
72+
- Small, Medium 크기 지원
73+
- 15분마다 갱신
74+
- 상승/하락 색상 구분
75+
```
76+
77+
### 여러 문서 조합
78+
79+
```
80+
swiftdata.md + widgets.md를 참고해서
81+
SwiftData에 저장된 할일 목록을 위젯에 표시하는 코드를 만들어줘.
82+
```
83+
84+
### 수정 요청
85+
86+
```
87+
방금 만든 위젯에 activitykit.md를 참고해서
88+
Live Activity 기능을 추가해줘.
89+
```
90+
91+
### 특정 부분만 요청
92+
93+
```
94+
widgets.md의 "인터랙티브 위젯" 섹션을 참고해서
95+
버튼을 누르면 카운터가 증가하는 위젯을 만들어줘.
96+
```
97+
98+
---
99+
100+
## 📁 문서별 사용 시나리오
101+
102+
| 문서 | 이럴 때 사용 |
103+
|------|------------|
104+
| `widgets.md` | "위젯 만들어줘", "홈화면에 표시", "잠금화면 위젯" |
105+
| `activitykit.md` | "Live Activity", "Dynamic Island", "배달 추적" |
106+
| `swiftdata.md` | "데이터 저장", "CRUD", "@Model", "로컬 DB" |
107+
| `swiftui-observation.md` | "@Observable", "상태 관리", "MVVM" |
108+
| `foundation-models.md` | "AI 챗봇", "온디바이스 AI", "LLM" |
109+
| `storekit.md` | "인앱결제", "구독", "프리미엄", "결제" |
110+
| `core-bluetooth.md` | "블루투스", "BLE", "기기 연결", "IoT" |
111+
112+
---
113+
114+
## ✅ 좋은 프롬프트 작성법
115+
116+
### DO ✅
117+
118+
```
119+
widgets.md를 참고해서 만들어줘:
120+
121+
1. 목표: 오늘의 운동 목표 달성률을 보여주는 위젯
122+
2. 크기: Small, Medium
123+
3. 데이터: HealthKit에서 걸음수 가져오기
124+
4. 갱신: 30분마다
125+
5. 디자인: 원형 프로그레스 바
126+
```
127+
128+
### DON'T ❌
129+
130+
```
131+
위젯 만들어줘
132+
```
133+
134+
→ 구체적인 요구사항 + 참조 문서가 있어야 정확한 코드 생성 가능
135+
136+
---
137+
138+
## 🔧 문제 해결
139+
140+
### "코드가 컴파일 안 돼요"
141+
142+
1. 문서 전체를 제공했는지 확인
143+
2. iOS/Xcode 버전 명시: "iOS 17+, Xcode 15에서 작동하게 해줘"
144+
3. 에러 메시지와 함께 수정 요청
145+
146+
### "오래된 API를 사용해요"
147+
148+
```
149+
iOS 17+ 최신 API만 사용해줘.
150+
ObservableObject 대신 @Observable 사용.
151+
```
152+
153+
### "일부 기능만 필요해요"
154+
155+
```
156+
widgets.md의 "전체 작동 예제" 섹션만 참고해서
157+
최소한의 코드로 만들어줘.
158+
```
159+
160+
---
161+
162+
## 🎓 실전 예제
163+
164+
### 예제 1: 날씨 + 위젯
165+
166+
**프롬프트:**
167+
```
168+
widgets.md를 참고해서 날씨 위젯을 만들어줘.
169+
170+
요구사항:
171+
- WeatherKit 대신 하드코딩된 데이터 사용 (테스트용)
172+
- Small: 온도 + 아이콘
173+
- Medium: 온도 + 3시간 예보
174+
- 배경: 날씨에 따라 그라디언트 변경
175+
```
176+
177+
### 예제 2: 할일 앱 전체
178+
179+
**프롬프트:**
180+
```
181+
swiftdata.md + swiftui-observation.md를 참고해서
182+
할일 관리 앱을 만들어줘.
183+
184+
기능:
185+
- 할일 추가/삭제/완료
186+
- 카테고리 분류
187+
- 마감일 설정
188+
- 오늘 할일 필터
189+
```
190+
191+
### 예제 3: 구독 + 결제
192+
193+
**프롬프트:**
194+
```
195+
storekit.md를 참고해서 프리미엄 구독 화면을 만들어줘.
196+
197+
요구사항:
198+
- 월간/연간 구독 옵션
199+
- 7일 무료 체험
200+
- 구매 복원 버튼
201+
- 구독 시 광고 제거
202+
```
203+
204+
---
205+
206+
## 📚 추가 학습
207+
208+
AI Reference로 기본 코드를 생성한 후:
209+
210+
1. **📝 블로그**: 개념 이해 → [m1zz.github.io/HIGLab](https://m1zz.github.io/HIGLab/)
211+
2. **📚 DocC**: 단계별 학습 → `tutorials/` 폴더
212+
3. **💻 샘플**: 실전 코드 → `samples/` 폴더
213+
214+
---
215+
216+
## 💡 팁
217+
218+
1. **문서 최신 상태 유지**: `git pull`로 최신 버전 받기
219+
2. **조합 활용**: 여러 문서를 함께 제공하면 복합 기능 구현 가능
220+
3. **점진적 요청**: 한번에 모든 걸 요청하지 말고 단계별로
221+
4. **피드백 루프**: 생성된 코드 실행 → 에러 수정 요청 → 반복
222+
223+
---
224+
225+
Made with ❤️ for AI-assisted iOS Development

site/ai-reference/README.md

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
# 🤖 AI Reference
2+
3+
> **AI 코드 생성을 위한 참조 문서**
4+
>
5+
> 이 폴더의 문서들은 Claude, GPT 등 AI가 iOS/SwiftUI 코드를 정확하게 생성할 수 있도록 설계되었습니다.
6+
7+
## 📖 [사용 가이드 (HOW-TO-USE.md)](HOW-TO-USE.md)
8+
9+
👉 **처음이라면 이 가이드를 먼저 읽어주세요!**
10+
11+
- 프롬프트 작성법
12+
- 실전 예제
13+
- 문제 해결 팁
14+
15+
---
16+
17+
## 📚 문서 목록 (50개)
18+
19+
### 🚀 App Frameworks
20+
| 문서 | 설명 | 주요 키워드 |
21+
|------|------|------------|
22+
| [swiftui.md](swiftui.md) | SwiftUI 기본 | View, Modifier, State |
23+
| [swiftui-observation.md](swiftui-observation.md) | @Observable 상태 관리 | @Observable, @Bindable, @Environment |
24+
| [swiftdata.md](swiftdata.md) | SwiftData CRUD | @Model, @Query, ModelContainer |
25+
| [widgets.md](widgets.md) | WidgetKit 위젯 구현 | Timeline, Provider, Widget Family |
26+
| [activitykit.md](activitykit.md) | Live Activity, Dynamic Island | ActivityAttributes, ContentState |
27+
| [appintents.md](appintents.md) | App Intents, Siri 연동 | AppIntent, AppShortcut |
28+
| [foundation-models.md](foundation-models.md) | 온디바이스 AI | LanguageModelSession, Tool |
29+
| [tipkit.md](tipkit.md) | 팁 표시 | Tip, TipView, 규칙 |
30+
31+
### 💳 App Services
32+
| 문서 | 설명 | 주요 키워드 |
33+
|------|------|------------|
34+
| [storekit.md](storekit.md) | 인앱결제, 구독 | Product, Transaction, purchase() |
35+
| [passkit.md](passkit.md) | Apple Pay, Wallet | PKPaymentRequest, PassKit |
36+
| [cloudkit.md](cloudkit.md) | iCloud 동기화 | CKContainer, CKRecord |
37+
| [authservices.md](authservices.md) | Sign in with Apple | ASAuthorizationController |
38+
| [localauth.md](localauth.md) | 생체인증 | LAContext, FaceID, TouchID |
39+
| [cryptokit.md](cryptokit.md) | 암호화 | AES, SHA, Signature |
40+
| [healthkit.md](healthkit.md) | 건강 데이터 | HKHealthStore, HKQuery |
41+
| [mapkit.md](mapkit.md) | 지도 | Map, MKMapItem, Look Around |
42+
| [corelocation.md](corelocation.md) | 위치 서비스 | CLLocationManager, Geofencing |
43+
| [coreml.md](coreml.md) | 머신러닝 | MLModel, Vision 통합 |
44+
| [vision.md](vision.md) | 이미지 분석 | VNRequest, OCR, 객체 감지 |
45+
| [notifications.md](notifications.md) | 알림 | UNUserNotificationCenter |
46+
| [shareplay.md](shareplay.md) | SharePlay | GroupActivity, 동기화 |
47+
| [eventkit.md](eventkit.md) | 캘린더, 리마인더 | EKEventStore, EKEvent |
48+
| [contacts.md](contacts.md) | 연락처 | CNContactStore, CNContact |
49+
| [musickit.md](musickit.md) | Apple Music | MusicKit, MusicPlayer |
50+
51+
### 🎮 Graphics & Media
52+
| 문서 | 설명 | 주요 키워드 |
53+
|------|------|------------|
54+
| [arkit.md](arkit.md) | 증강현실 | ARSession, ARView |
55+
| [realitykit.md](realitykit.md) | 3D 렌더링 | Entity, RealityView |
56+
| [spritekit.md](spritekit.md) | 2D 게임 | SKScene, SKNode |
57+
| [coreimage.md](coreimage.md) | 이미지 필터 | CIFilter, CIContext |
58+
| [pencilkit.md](pencilkit.md) | 드로잉 | PKCanvasView, PKDrawing |
59+
| [pdfkit.md](pdfkit.md) | PDF 처리 | PDFView, PDFDocument |
60+
| [avfoundation.md](avfoundation.md) | 카메라, 오디오 | AVCaptureSession |
61+
| [avkit.md](avkit.md) | 비디오 재생 | VideoPlayer, AVPlayer |
62+
| [photosui.md](photosui.md) | 사진 앱 연동 | PhotosPicker, PHAsset |
63+
| [corehaptics.md](corehaptics.md) | 햅틱 피드백 | CHHapticEngine |
64+
| [shazamkit.md](shazamkit.md) | 음악 인식 | SHSession, SHMediaItem |
65+
| [image-playground.md](image-playground.md) | AI 이미지 생성 | ImagePlaygroundSheet |
66+
| [weatherkit.md](weatherkit.md) | 날씨 데이터 | WeatherService, Weather |
67+
68+
### 🔧 System & Network
69+
| 문서 | 설명 | 주요 키워드 |
70+
|------|------|------------|
71+
| [core-bluetooth.md](core-bluetooth.md) | BLE 기기 연결 | CBCentralManager, CBPeripheral |
72+
| [core-nfc.md](core-nfc.md) | NFC 태그 | NFCNDEFReaderSession |
73+
| [multipeerconnectivity.md](multipeerconnectivity.md) | P2P 통신 | MCSession, MCBrowser |
74+
| [network.md](network.md) | 저수준 네트워크 | NWConnection, NWListener |
75+
| [callkit.md](callkit.md) | VoIP 통화 | CXProvider, CXCallController |
76+
| [wifi-aware.md](wifi-aware.md) | Wi-Fi 직접 연결 | DevicePicker, NWBrowser |
77+
78+
### 🆕 iOS 18+ Apple Intelligence
79+
| 문서 | 설명 | 주요 키워드 |
80+
|------|------|------------|
81+
| [visual-intelligence.md](visual-intelligence.md) | 시각 분석 | ImageAnalyzer, VisionKit |
82+
| [alarmkit.md](alarmkit.md) | 알람 시계 | AlarmManager, Alarm |
83+
| [energykit.md](energykit.md) | 에너지 데이터 | EnergyManager, GridStatus |
84+
| [permissionkit.md](permissionkit.md) | 통합 권한 관리 | PermissionManager |
85+
| [relevancekit.md](relevancekit.md) | 맥락 기반 추천 | RelevanceEngine, Context |
86+
| [accessorysetupkit.md](accessorysetupkit.md) | 액세서리 페어링 | ASAccessorySession |
87+
| [extensibleimage.md](extensibleimage.md) | 이미지 편집 확장 | EIImageEditingProvider |
88+
89+
---
90+
91+
## 🎯 사용 방법
92+
93+
### 1. AI에게 문서 제공
94+
95+
```
96+
이 문서를 참고해서 날씨 위젯을 만들어줘:
97+
98+
[widgets.md 내용 붙여넣기]
99+
```
100+
101+
### 2. 프로젝트 컨텍스트로 사용
102+
103+
AI 도구(Claude, Cursor, GitHub Copilot 등)의 컨텍스트에 이 폴더를 포함시키면,
104+
정확한 iOS 코드 생성이 가능합니다.
105+
106+
### 3. 조합 사용
107+
108+
```
109+
widgets.md + swiftdata.md 참고해서
110+
SwiftData로 저장되는 할일을 표시하는 위젯 만들어줘
111+
```
112+
113+
---
114+
115+
## 📝 문서 구조
116+
117+
각 문서는 다음 구조를 따릅니다:
118+
119+
1. **개요**: 프레임워크 설명 (1-2문장)
120+
2. **필수 Import**: 필요한 import 문
121+
3. **프로젝트 설정**: Info.plist, Capability 등
122+
4. **핵심 구성요소**: 주요 타입/프로토콜 설명
123+
5. **전체 작동 예제**: 복사해서 바로 실행 가능한 코드
124+
6. **고급 패턴**: 추가 사용 사례
125+
7. **주의사항**: 흔한 실수와 해결법
126+
127+
---
128+
129+
## ✅ 코드 품질
130+
131+
모든 예제 코드는:
132+
- ✅ Swift 5.9+ / iOS 17+ 기준 (일부 iOS 18+)
133+
- ✅ 컴파일 가능한 전체 코드
134+
- ✅ SwiftUI 최신 패턴 (@Observable 등)
135+
- ✅ #Preview 매크로 포함
136+
- ✅ 한글 주석
137+
138+
---
139+
140+
## 🔗 관련 자료
141+
142+
- [📝 블로그](https://m1zz.github.io/HIGLab/) - 상세 설명
143+
- [📚 DocC 튜토리얼](../tutorials/) - 단계별 학습
144+
- [💻 샘플 프로젝트](../samples/) - 실전 코드
145+
146+
---
147+
148+
Made for AI, by [개발자리](https://youtube.com/@Leeo25)

0 commit comments

Comments
 (0)