@silbaram/artifact-driven-agent 0.1.7 → 0.2.3

package/templates/library/artifacts/examples.md

@@ -1,157 +1,157 @@
-# Examples (사용 예제)
-
-> 라이브러리 사용 예제 모음
-> 실제 동작하는 코드로 작성
-
----
-
-## 0. 문서 메타
-
-| 항목 | 값 |
-|------|-----|
-| 라이브러리 버전 | v1.0.0 |
-| 최종 수정 | YYYY-MM-DD |
-
----
-
-## 1. 빠른 시작 (Quick Start)
-
-### 1.1 설치
-
-```bash
-pip install [library-name]
-```
-
-### 1.2 기본 사용
-
-```python
-from library import main_function
-
-# 가장 간단한 사용법
-result = main_function("hello")
-print(result.value)  # 출력: processed: hello
-```
-
----
-
-## 2. 기본 예제
-
-### 2.1 예제: [시나리오 이름]
-
-**목적:** [이 예제가 보여주는 것]
-
-```python
-from library import main_function, Config
-
-# 설정
-config = Config(timeout=30)
-
-# 실행
-result = main_function("input", config=config)
-
-# 결과 확인
-if result.status == "success":
-    print(f"성공: {result.value}")
-else:
-    print(f"실패: {result.error}")
-```
-
-**실행 결과:**
-```
-성공: processed: input
-```
-
----
-
-### 2.2 예제: [다른 시나리오]
-
-**목적:** [설명]
-
-```python
-# 예제 코드
-```
-
----
-
-## 3. 고급 예제
-
-### 3.1 비동기 처리
-
-```python
-import asyncio
-from library import async_function
-
-async def main():
-    result = await async_function("data")
-    print(result)
-
-asyncio.run(main())
-```
-
-### 3.2 에러 처리
-
-```python
-from library import main_function, LibraryError
-
-try:
-    result = main_function("")
-except LibraryError as e:
-    print(f"에러 발생: {e.message}")
-    print(f"에러 코드: {e.code}")
-```
-
-### 3.3 커스텀 설정
-
-```python
-from library import configure, main_function
-
-# 전역 설정
-configure(
-    timeout=60,
-    retries=5,
-    debug=True
-)
-
-# 설정이 적용된 상태로 실행
-result = main_function("data")
-```
-
----
-
-## 4. 통합 예제
-
-### 4.1 [프레임워크]와 함께 사용
-
-```python
-# 프레임워크 통합 예제
-```
-
-### 4.2 다른 라이브러리와 함께
-
-```python
-# 다른 라이브러리와 조합 예제
-```
-
----
-
-## 5. FAQ 및 팁
-
-### Q: [자주 묻는 질문]?
-
-```python
-# 해결 방법 코드
-```
-
-### Q: [다른 질문]?
-
-```python
-# 해결 방법 코드
-```
-
----
-
-## 6. 변경 이력
-
-| 버전 | 날짜 | 변경 내용 | Task |
-|------|------|----------|------|
-| v1.0.0 | YYYY-MM-DD | 초기 예제 작성 | - |
+# Examples (사용 예제)
+
+> 라이브러리 사용 예제 모음
+> 실제 동작하는 코드로 작성
+
+---
+
+## 0. 문서 메타
+
+| 항목 | 값 |
+|------|-----|
+| 라이브러리 버전 | v1.0.0 |
+| 최종 수정 | YYYY-MM-DD |
+
+---
+
+## 1. 빠른 시작 (Quick Start)
+
+### 1.1 설치
+
+```bash
+pip install [library-name]
+```
+
+### 1.2 기본 사용
+
+```python
+from library import main_function
+
+# 가장 간단한 사용법
+result = main_function("hello")
+print(result.value)  # 출력: processed: hello
+```
+
+---
+
+## 2. 기본 예제
+
+### 2.1 예제: [시나리오 이름]
+
+**목적:** [이 예제가 보여주는 것]
+
+```python
+from library import main_function, Config
+
+# 설정
+config = Config(timeout=30)
+
+# 실행
+result = main_function("input", config=config)
+
+# 결과 확인
+if result.status == "success":
+    print(f"성공: {result.value}")
+else:
+    print(f"실패: {result.error}")
+```
+
+**실행 결과:**
+```
+성공: processed: input
+```
+
+---
+
+### 2.2 예제: [다른 시나리오]
+
+**목적:** [설명]
+
+```python
+# 예제 코드
+```
+
+---
+
+## 3. 고급 예제
+
+### 3.1 비동기 처리
+
+```python
+import asyncio
+from library import async_function
+
+async def main():
+    result = await async_function("data")
+    print(result)
+
+asyncio.run(main())
+```
+
+### 3.2 에러 처리
+
+```python
+from library import main_function, LibraryError
+
+try:
+    result = main_function("")
+except LibraryError as e:
+    print(f"에러 발생: {e.message}")
+    print(f"에러 코드: {e.code}")
+```
+
+### 3.3 커스텀 설정
+
+```python
+from library import configure, main_function
+
+# 전역 설정
+configure(
+    timeout=60,
+    retries=5,
+    debug=True
+)
+
+# 설정이 적용된 상태로 실행
+result = main_function("data")
+```
+
+---
+
+## 4. 통합 예제
+
+### 4.1 [프레임워크]와 함께 사용
+
+```python
+# 프레임워크 통합 예제
+```
+
+### 4.2 다른 라이브러리와 함께
+
+```python
+# 다른 라이브러리와 조합 예제
+```
+
+---
+
+## 5. FAQ 및 팁
+
+### Q: [자주 묻는 질문]?
+
+```python
+# 해결 방법 코드
+```
+
+### Q: [다른 질문]?
+
+```python
+# 해결 방법 코드
+```
+
+---
+
+## 6. 변경 이력
+
+| 버전 | 날짜 | 변경 내용 | Task |
+|------|------|----------|------|
+| v1.0.0 | YYYY-MM-DD | 초기 예제 작성 | - |

package/templates/library/artifacts/public-api.md

@@ -1,197 +1,197 @@
-# Public API Specification
-
-> 라이브러리의 공개 인터페이스 정의
-> 사용자에게 노출되는 모든 API를 문서화
-
----
-
-## 0. 문서 메타
-
-| 항목 | 값 |
-|------|-----|
-| 라이브러리명 | [이름] |
-| 현재 버전 | v1.0.0 |
-| 최종 수정 | YYYY-MM-DD |
-
----
-
-## 1. 개요
-
-### 1.1 라이브러리 소개
-
-[라이브러리 한 줄 설명]
-
-### 1.2 설치
-
-```bash
-# npm
-npm install [package-name]
-
-# pip
-pip install [package-name]
-
-# 기타
-[설치 명령]
-```
-
-### 1.3 빠른 시작
-
-```python
-# 기본 사용 예시
-import library
-
-result = library.main_function()
-```
-
----
-
-## 2. 공개 API 목록
-
-| API | 설명 | 버전 | 상태 |
-|-----|------|------|:----:|
-| `mainFunction()` | 주요 기능 | v1.0.0 | ✅ |
-| `helperFunction()` | 보조 기능 | v1.0.0 | ✅ |
-| `oldFunction()` | 이전 기능 | v1.0.0 | ⚠️ Deprecated |
-
-상태: ✅ 안정 / ⚠️ Deprecated / 🧪 실험적
-
----
-
-## 3. API 상세
-
-### 3.1 mainFunction
-
-```python
-def main_function(param1: str, param2: int = 10) -> Result:
-    """
-    주요 기능 설명
-    
-    Args:
-        param1: 첫 번째 파라미터 설명
-        param2: 두 번째 파라미터 (기본값: 10)
-    
-    Returns:
-        Result: 결과 객체
-    
-    Raises:
-        ValueError: param1이 빈 문자열인 경우
-        TypeError: param2가 정수가 아닌 경우
-    
-    Example:
-        >>> result = main_function("hello", 20)
-        >>> print(result.value)
-        'processed: hello'
-    """
-```
-
-**파라미터:**
-
-| 이름 | 타입 | 필수 | 기본값 | 설명 |
-|------|------|:----:|--------|------|
-| param1 | str | ✅ | - | 첫 번째 파라미터 |
-| param2 | int | ❌ | 10 | 두 번째 파라미터 |
-
-**반환값:**
-
-| 타입 | 설명 |
-|------|------|
-| Result | 결과 객체 |
-
-**예외:**
-
-| 예외 | 조건 |
-|------|------|
-| ValueError | param1이 빈 문자열 |
-| TypeError | param2가 정수 아님 |
-
-**예시:**
-
-```python
-# 기본 사용
-result = main_function("hello")
-
-# 옵션 지정
-result = main_function("hello", param2=20)
-```
-
----
-
-### 3.2 helperFunction
-
-(동일 형식으로 작성)
-
----
-
-## 4. 데이터 타입
-
-### 4.1 Result
-
-```python
-class Result:
-    value: str       # 처리 결과
-    status: str      # 상태 ("success" | "error")
-    metadata: dict   # 추가 정보
-```
-
-**필드:**
-
-| 필드 | 타입 | 설명 |
-|------|------|------|
-| value | str | 처리 결과 |
-| status | str | 상태 |
-| metadata | dict | 추가 정보 |
-
----
-
-## 5. 상수 및 설정
-
-### 5.1 상수
-
-| 상수 | 값 | 설명 |
-|------|-----|------|
-| DEFAULT_TIMEOUT | 30 | 기본 타임아웃 (초) |
-| MAX_RETRIES | 3 | 최대 재시도 횟수 |
-
-### 5.2 설정
-
-```python
-# 전역 설정
-library.configure(
-    timeout=60,
-    debug=True
-)
-```
-
----
-
-## 6. Deprecated API
-
-> 다음 Major 버전에서 제거 예정
-
-### 6.1 oldFunction (Deprecated since v1.2.0)
-
-```python
-# ⚠️ Deprecated: main_function() 사용 권장
-def old_function(param):
-    ...
-```
-
-**대체 방법:**
-
-```python
-# Before (deprecated)
-old_function(param)
-
-# After (recommended)
-main_function(param)
-```
-
----
-
-## 7. 변경 이력
-
-| 버전 | 날짜 | 변경 내용 | Task |
-|------|------|----------|------|
-| v1.0.0 | YYYY-MM-DD | 초기 릴리스 | - |
-| v1.1.0 | YYYY-MM-DD | helperFunction 추가 | TASK-003 |
-| v1.2.0 | YYYY-MM-DD | oldFunction deprecated | TASK-005 |
+# Public API Specification
+
+> 라이브러리의 공개 인터페이스 정의
+> 사용자에게 노출되는 모든 API를 문서화
+
+---
+
+## 0. 문서 메타
+
+| 항목 | 값 |
+|------|-----|
+| 라이브러리명 | [이름] |
+| 현재 버전 | v1.0.0 |
+| 최종 수정 | YYYY-MM-DD |
+
+---
+
+## 1. 개요
+
+### 1.1 라이브러리 소개
+
+[라이브러리 한 줄 설명]
+
+### 1.2 설치
+
+```bash
+# npm
+npm install [package-name]
+
+# pip
+pip install [package-name]
+
+# 기타
+[설치 명령]
+```
+
+### 1.3 빠른 시작
+
+```python
+# 기본 사용 예시
+import library
+
+result = library.main_function()
+```
+
+---
+
+## 2. 공개 API 목록
+
+| API | 설명 | 버전 | 상태 |
+|-----|------|------|:----:|
+| `mainFunction()` | 주요 기능 | v1.0.0 | ✅ |
+| `helperFunction()` | 보조 기능 | v1.0.0 | ✅ |
+| `oldFunction()` | 이전 기능 | v1.0.0 | ⚠️ Deprecated |
+
+상태: ✅ 안정 / ⚠️ Deprecated / 🧪 실험적
+
+---
+
+## 3. API 상세
+
+### 3.1 mainFunction
+
+```python
+def main_function(param1: str, param2: int = 10) -> Result:
+    """
+    주요 기능 설명
+    
+    Args:
+        param1: 첫 번째 파라미터 설명
+        param2: 두 번째 파라미터 (기본값: 10)
+    
+    Returns:
+        Result: 결과 객체
+    
+    Raises:
+        ValueError: param1이 빈 문자열인 경우
+        TypeError: param2가 정수가 아닌 경우
+    
+    Example:
+        >>> result = main_function("hello", 20)
+        >>> print(result.value)
+        'processed: hello'
+    """
+```
+
+**파라미터:**
+
+| 이름 | 타입 | 필수 | 기본값 | 설명 |
+|------|------|:----:|--------|------|
+| param1 | str | ✅ | - | 첫 번째 파라미터 |
+| param2 | int | ❌ | 10 | 두 번째 파라미터 |
+
+**반환값:**
+
+| 타입 | 설명 |
+|------|------|
+| Result | 결과 객체 |
+
+**예외:**
+
+| 예외 | 조건 |
+|------|------|
+| ValueError | param1이 빈 문자열 |
+| TypeError | param2가 정수 아님 |
+
+**예시:**
+
+```python
+# 기본 사용
+result = main_function("hello")
+
+# 옵션 지정
+result = main_function("hello", param2=20)
+```
+
+---
+
+### 3.2 helperFunction
+
+(동일 형식으로 작성)
+
+---
+
+## 4. 데이터 타입
+
+### 4.1 Result
+
+```python
+class Result:
+    value: str       # 처리 결과
+    status: str      # 상태 ("success" | "error")
+    metadata: dict   # 추가 정보
+```
+
+**필드:**
+
+| 필드 | 타입 | 설명 |
+|------|------|------|
+| value | str | 처리 결과 |
+| status | str | 상태 |
+| metadata | dict | 추가 정보 |
+
+---
+
+## 5. 상수 및 설정
+
+### 5.1 상수
+
+| 상수 | 값 | 설명 |
+|------|-----|------|
+| DEFAULT_TIMEOUT | 30 | 기본 타임아웃 (초) |
+| MAX_RETRIES | 3 | 최대 재시도 횟수 |
+
+### 5.2 설정
+
+```python
+# 전역 설정
+library.configure(
+    timeout=60,
+    debug=True
+)
+```
+
+---
+
+## 6. Deprecated API
+
+> 다음 Major 버전에서 제거 예정
+
+### 6.1 oldFunction (Deprecated since v1.2.0)
+
+```python
+# ⚠️ Deprecated: main_function() 사용 권장
+def old_function(param):
+    ...
+```
+
+**대체 방법:**
+
+```python
+# Before (deprecated)
+old_function(param)
+
+# After (recommended)
+main_function(param)
+```
+
+---
+
+## 7. 변경 이력
+
+| 버전 | 날짜 | 변경 내용 | Task |
+|------|------|----------|------|
+| v1.0.0 | YYYY-MM-DD | 초기 릴리스 | - |
+| v1.1.0 | YYYY-MM-DD | helperFunction 추가 | TASK-003 |
+| v1.2.0 | YYYY-MM-DD | oldFunction deprecated | TASK-005 |