zellyy-finance/docs/02_기술_문서/기술문서_관리.md

기술 문서 관리

개요

Zellyy Finance 프로젝트의 기술 문서는 코드와 함께 Gitea 저장소에서 관리됩니다. 이 문서는 기술 문서의 위치와 관리 방법에 대한 정보를 제공합니다.

기술 문서 위치

• 소스 코드 저장소: /Users/hansoo./Dev/Zellyy_Finance/docs/
• Git 저장소 URL: Zellyy_Finance Git Repository

문서 관리 원칙

• 단일 소스 원칙: 모든 코드 관련 기술 문서는 Gitea에서만 관리합니다.
• 옵시디언 참조 원칙: 옵시디언에는 Gitea의 문서를 참조하는 링크만 저장합니다.

주요 기술 문서 목록

API 문서

• API 엔드포인트: Zellyy Finance API의 모든 엔드포인트 설명
• API 인증: API 인증 방법 설명

데이터베이스 문서

• 데이터베이스 스키마: 데이터베이스 테이블 구조 및 관계 설명

설계 문서

• 아키텍처 설계: 시스템 아키텍처 설명

요구사항 문서

• 기능 요구사항: 시스템 기능 요구사항 설명

문서 업데이트 방법

기술 문서를 업데이트해야 할 경우, 다음 절차를 따릅니다:

1. Gitea 저장소의 문서만 수정합니다.
2. 변경 사항을 커밋하고 푸시합니다.
3. 필요한 경우 이 문서에 중요한 변경 사항을 기록합니다.

주의사항

• 옵시디언에는 코드나 코드 관련 기술 문서를 저장하지 않는 원칙을 따릅니다.
• 기술 문서와 코드의 일관성을 유지하기 위해 항상 Gitea의 문서를 참조하세요.

최근 업데이트

• 2025-02-27: 기술 문서 관리 원칙 수립 (Gitea에서만 관리)
• 2025-02-27: 기술 문서 참조 링크 추가