4ee07bc95c
프로젝트 전체 문서 작성 규칙 및 템플릿 정의 ## 주요 내용 - 문서 작성 5대 원칙 (명확성, 일관성, 완전성, 접근성, 유지보수성) - 문서 구조 표준 (필수 섹션, 섹션 순서) - 문서 유형별 가이드 (배포, 기능 명세, API, 트러블슈팅) - 작성 규칙 (마크다운 스타일, 명명 규칙, 코드 예시, 표, 다이어그램) - 예시 템플릿 (배포 가이드, API 문서) - 문서 검토 체크리스트 ## 문서 유형별 표준 구조 ### 배포/설치 가이드: 1. 문서 개요 → 2. 목차 → 3. 시스템 개요 → 4. 배포 전 확인사항 → 5. 배포 절차 → 6. 기능 명세 → 7. API 명세 → 8. 프론트엔드 구현 → 9. 테스트 가이드 → 10. 문제 해결 → 11. 변경 이력 ### API 문서: 1. 문서 개요 → 2. 목차 → 3. API 개요 → 4. 인증 방식 → 5. 엔드포인트 목록 → 6. 엔드포인트 상세 → 7. 에러 코드 → 8. 예시 코드 → 9. 변경 이력 ## 적용 대상 - 모든 신규 문서는 이 가이드를 따름 - 기존 문서는 점진적으로 표준화 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
TK-FB-Project 개발 문서
📚 문서 구조
이 디렉토리는 TK-FB-Project의 개발 및 유지보수를 위한 종합 문서 저장소입니다.
디렉토리 구조
docs/
├── README.md # 이 파일 - 문서 인덱스
├── architecture/ # 아키텍처 관련 문서
│ ├── OVERVIEW.md # 시스템 아키텍처 개요
│ ├── DATABASE.md # 데이터베이스 스키마 및 설계
│ └── API_DESIGN.md # API 설계 원칙
├── refactoring/ # 리팩토링 관련 문서
│ ├── PLAN.md # 리팩토링 계획 및 로드맵
│ ├── LOG.md # 리팩토링 작업 로그
│ └── ANALYSIS.md # 코드 분석 리포트
├── guides/ # 개발 가이드
│ ├── SETUP.md # 개발 환경 설정
│ ├── CODING_STYLE.md # 코딩 스타일 가이드
│ ├── GIT_WORKFLOW.md # Git 워크플로우
│ ├── SECURITY.md # 보안 가이드라인
│ └── TROUBLESHOOTING.md # 문제 해결 가이드
└── api/ # API 문서
├── ENDPOINTS.md # API 엔드포인트 목록
├── AUTHENTICATION.md # 인증 및 권한
└── EXAMPLES.md # API 사용 예제
📖 주요 문서
시작하기
- 개발 환경 설정 - 프로젝트 설정 및 실행 방법
- 시스템 아키텍처 - 전체 시스템 구조 이해
- 코딩 스타일 가이드 - 코드 작성 규칙
개발
- API 문서 - REST API 엔드포인트 레퍼런스
- 데이터베이스 스키마 - DB 구조 및 관계
- 문제 해결 - 자주 발생하는 문제 해결법
리팩토링
🔄 문서 업데이트 규칙
- 리팩토링 시: 변경 사항을
refactoring/LOG.md에 기록 - API 변경 시:
api/ENDPOINTS.md업데이트 - 아키텍처 변경 시: 관련 다이어그램 및 문서 갱신
- 새로운 기능 추가 시: 해당 가이드 문서 작성
📝 문서 작성 가이드
문서 작성 원칙
- 명확성: 기술 용어는 쉽게 설명
- 최신성: 코드 변경 시 즉시 업데이트
- 완결성: 독립적으로 이해 가능하도록 작성
- 예제 포함: 코드 예제와 스크린샷 활용
마크다운 스타일
# H1: 문서 제목 (한 문서에 한 개만)
## H2: 주요 섹션
### H3: 하위 섹션
- 리스트 사용
- 코드 블록 활용
- 테이블로 정보 정리
🔗 외부 리소스
📅 문서 이력
| 날짜 | 버전 | 변경 내용 | 작성자 |
|---|---|---|---|
| 2025-12-11 | 1.0 | 문서 구조 초기 생성 | Claude Code |
📧 문의
문서 관련 질문이나 개선 제안은 프로젝트 관리자에게 문의하세요.