검색 K
밝은/어두운 배경
Briefing-K 시스템 문서
게시물 정보
- 작성일: 2026년 6월 8일 월요일 (약 1개월 전)
- 글쓴이: claude.ai
- 주제어: #기술 문서 #운영 매뉴얼 #claude.ai #Briefing-K 시스템 문서
대상 독자: 본 시스템을 처음 접하는 개발자
마지막 수정: 2026-06
시스템 개요
Briefing-K는 공공 정책 관련 RSS 피드를 자동으로 수집하고, 이를 VitePress 기반 정적 사이트에 마크다운 문서로 발행하는 시스템입니다.
RSS 피드 수집 → JSON 저장 → Markdown 생성 → VitePress 빌드 → Vercel 배포시스템 구성
| 파트 | 위치 | 역할 |
|---|---|---|
| 1. RSS 스크래퍼 | scraper/ | RSS 수집 · JSON 저장 · Markdown 생성 |
| 2. 피드 관리 API | api/ · scripts/ | 피드 등록 신청 · 철회 · 운영자 검토 |
| 3. 인프라 | .github/workflows/ · 루트 설정 파일 | 수집 자동화 · 빌드 · Vercel 배포 |
| 4. VitePress 자동 설정 | docs/.vitepress/composables/ | Nav · Sidebar 자동 생성 |
문서 구조
docs/
├── README.md ← 지금 여기
│
├── 01-overview/
│ ├── 01-architecture.md ← 전체 구성도와 파트 간 관계
│ └── 02-data-flow.md ← 데이터 흐름 상세
│
├── 02-scraper/ ← 파트 1 상세 문서
│ ├── 00-README.md ← 파트 진입점 · 파일 맵
│ ├── 01-configuration.md ← 설정값 변경 방법
│ ├── 02-file-structure.md ← 출력 파일 구조와 경로 규칙
│ └── 03-modules.md ← 모듈 역할과 의존 관계
│
├── 03-api/ ← 파트 2 상세 문서
│ ├── 00-README.md ← 파트 진입점 · 파일 맵
│ ├── 01-endpoints.md ← API 엔드포인트 스펙
│ ├── 02-db-schema.md ← DB 테이블 전체 스키마
│ ├── 03-status-flow.md ← 등록·철회 상태 흐름
│ ├── 04-mailer.md ← 이메일 발송 구조
│ └── 05-local-dev.md ← 로컬 개발 환경 세팅
│
├── 04-scripts-workflows/ ← 파트 3 상세 문서
│ ├── 00-README.md ← 파트 진입점 · 배포 흐름 요약
│ ├── 01-workflows.md ← GitHub Actions 워크플로우 상세
│ └── 02-project-setup.md ← package.json · tsconfig · 설정 파일
│
├── 05-operations/
│ ├── 01-runbook.md ← 장애 대응 절차
│ └── 02-adding-feed.md ← 피드 추가/철회 전체 절차
│
└── 06-vitepress-auto-config/ ← 파트 4 상세 문서
├── 00-README.md ← 파트 진입점 · 파일 맵
├── 01-how-it-works.md ← 동작 원리 · 디렉토리 설계 원칙
├── 02-configuration.md ← options.ts 설정값 전체 가이드
└── 03-modules.md ← 모듈 역할과 의존 관계빠른 참조
| 목적 | 문서 |
|---|---|
| 피드를 새로 등록하고 싶다 | 05-operations/02-adding-feed.md |
| 스크래퍼가 멈췄다 | 05-operations/01-runbook.md |
| 스크래퍼 설정값을 바꾸고 싶다 | 02-scraper/01-configuration.md |
| 출력 파일 경로를 알고 싶다 | 02-scraper/02-file-structure.md |
| 스크래퍼 코드 구조를 파악하고 싶다 | 02-scraper/03-modules.md |
| API 엔드포인트 동작을 확인하고 싶다 | 03-api/01-endpoints.md |
| DB 테이블 구조를 알고 싶다 | 03-api/02-db-schema.md |
| 등록·철회 상태 흐름을 이해하고 싶다 | 03-api/03-status-flow.md |
| 이메일 발송 구조를 파악하고 싶다 | 03-api/04-mailer.md |
| 로컬 개발 환경을 세팅하고 싶다 | 03-api/05-local-dev.md |
| GitHub Actions 워크플로우를 이해하고 싶다 | 04-scripts-workflows/01-workflows.md |
| Vercel 배포가 안 될 때 | 04-scripts-workflows/01-workflows.md |
| 로컬 개발 명령어를 확인하고 싶다 | 04-scripts-workflows/02-project-setup.md |
| Nav · Sidebar 자동 생성 원리를 이해하고 싶다 | 06-vitepress-auto-config/01-how-it-works.md |
| options.ts 설정을 변경하고 싶다 | 06-vitepress-auto-config/02-configuration.md |
| 자동 설정 코드 구조를 파악하고 싶다 | 06-vitepress-auto-config/03-modules.md |
| 전체 데이터 흐름을 이해하고 싶다 | 01-overview/02-data-flow.md |