search

humanet1603 / krx_using_api

0 stars 0 forks source link

GitHub Wiki는 프로젝트의 문서화 #1

Closed humanet1603 closed 6 months ago

humanet1603 commented 6 months ago

GitHub Wiki는 프로젝트의 문서화를 돕기 위해 제공되는 기능으로, 프로젝트와 관련된 다양한 정보를 체계적으로 정리하고 공유할 수 있는 공간입니다. Wiki는 프로젝트의 설명서, 가이드, 기술 문서, 작업 기록 등을 작성하는 데 유용합니다. GitHub Wiki의 주요 기능과 활용 방법을 설명드리겠습니다.

GitHub Wiki의 주요 기능

  1. 페이지 생성 및 편집

    • 프로젝트와 관련된 다양한 주제를 페이지로 생성하고, Markdown을 사용하여 편집할 수 있습니다.
    • 각 페이지는 독립적으로 관리되며, 내용에 따라 계층 구조를 만들 수 있습니다.

  2. Markdown 지원

    • Markdown 문법을 사용하여 문서를 작성할 수 있습니다. 코드 블록, 이미지, 링크, 표 등을 쉽게 포함할 수 있습니다.

  3. 버전 관리

    • Wiki 페이지도 GitHub 리포지토리와 마찬가지로 버전 관리를 할 수 있습니다. 페이지의 변경 내역을 추적하고, 이전 버전으로 복구할 수 있습니다.

  4. 내비게이션 및 구조화

    • Wiki의 홈 페이지를 설정하고, 페이지 간의 링크를 통해 내비게이션을 구성할 수 있습니다.
    • 사이드바와 내비게이션 바를 사용하여 주요 페이지에 대한 접근성을 높일 수 있습니다.

  5. 공유 및 협업

    • 팀 멤버와 Wiki를 통해 협업할 수 있으며, 공개 설정을 통해 모든 GitHub 사용자에게 문서를 공개할 수 있습니다.
    • 각 페이지에 대한 편집 권한을 설정할 수 있습니다.

GitHub Wiki 활용 예시

1. Wiki 페이지 생성

  1. GitHub 리포지토리로 이동

    • Wiki를 활성화하려면 리포지토리의 상단 메뉴에서 "Wiki" 탭을 클릭합니다.

  2. 페이지 생성

    • "Create the first page" 버튼을 클릭하여 첫 번째 Wiki 페이지를 생성합니다.

2. 문서 작성

# 프로젝트 개요

이 프로젝트는 이동평균 교차 전략을 사용한 주식투자 전략을 구현합니다.

## 주요 기능
- 데이터 수집 및 전처리
- 이동평균 계산
- 매매 신호 생성
- 성과 평가

## 데이터 수집
데이터는 yfinance 라이브러리를 사용하여 수집합니다.

```python
import yfinance as yf
data = yf.download('AAPL', start='2020-01-01', end='2023-12-31')

매매 신호 생성

단기 이동평균선과 장기 이동평균선을 계산하여 매매 신호를 생성합니다.

data['SMA20'] = data['Close'].rolling(window=20).mean()
data['SMA50'] = data['Close'].rolling(window=50).mean()
data['Signal'] = 0
data['Signal'][20:] = np.where(data['SMA20'][20:] > data['SMA50'][20:], 1, 0)

#### 3. Wiki 페이지 간 링크 설정

- **내비게이션 바 설정**: Wiki 페이지 간 링크를 설정하여 내비게이션 바를 구성합니다.

```markdown
# Home
- [프로젝트 개요](Home)
- [데이터 수집](Data-Collection)
- [매매 신호 생성](Trading-Signal-Generation)
- [성과 평가](Performance-Evaluation)

4. 버전 관리 및 변경 내역 추적

5. 협업 및 권한 설정

GitHub Wiki 활용 예시

예시: 이동평균 교차 전략 문서화

  1. 홈 페이지 작성:
    • 프로젝트의 개요와 주요 기능을 설명합니다.
# 이동평균 교차 전략

이 프로젝트는 이동평균 교차 전략을 사용하여 주식을 매매하는 방법을 구현합니다.

## 주요 기능
- 데이터 수집 및 전처리
- 이동평균 계산
- 매매 신호 생성
- 성과 평가

[데이터 수집](Data-Collection) | [매매 신호 생성](Trading-Signal-Generation) | [성과 평가](Performance-Evaluation)
  1. 데이터 수집 페이지 작성:
# 데이터 수집

## yfinance 라이브러리를 사용한 데이터 수집
```python
import yfinance as yf
data = yf.download('AAPL', start='2020-01-01', end='2023-12-31')
data.to_csv('aapl_data.csv')

Home


3. **매매 신호 생성 페이지 작성**:

```markdown
# 매매 신호 생성

## 이동평균 계산 및 매매 신호 생성
```python
data['SMA20'] = data['Close'].rolling(window=20).mean()
data['SMA50'] = data['Close'].rolling(window=50).mean()
data['Signal'] = 0
data['Signal'][20:] = np.where(data['SMA20'][20:] > data['SMA50'][20:], 1, 0)
data.to_csv('aapl_signals.csv')

Home | 데이터 수집



### 결론

GitHub Wiki는 프로젝트의 문서화를 체계적으로 관리하고 공유할 수 있는 유용한 도구입니다. Markdown을 사용하여 쉽게 문서를 작성하고, 버전 관리 및 협업 기능을 활용하여 팀원들과 효과적으로 정보를 공유할 수 있습니다. 이를 통해 프로젝트의 기술 문서, 가이드, 작업 기록 등을 효과적으로 관리할 수 있습니다.