Back to list
jskjw157

validate-docs

by jskjw157

0🍴 0📅 Jan 25, 2026

SKILL.md


name: validate-docs description: "기획 문서 정합성 검증 스킬. 화면 정의서, DB 정의서, 프로젝트 기획서, API 계약서 간의 일관성을 검사합니다. 사용 시기: (1) 문서 수정 후 정합성 확인 (2) 새 화면/기능 추가 후 누락 확인 (3) 전체 문서 리뷰 시 (4) /validate-docs 호출 시"

기획 문서 정합성 검증

개요

FanPulse 기획 문서들(화면 정의서, DB 정의서, 프로젝트 기획서, API 계약서) 간의 정합성을 검증합니다.

검증 워크플로우

1. 문서 로드 → 2. 검증 수행 → 3. 불일치 리포트 생성

검증 항목

1. 화면 ↔ DB 정합성

화면에서 필요한 데이터가 DB에 정의되어 있는지 확인

검증 항목설명
화면별 필수 테이블화면 기능에 필요한 DB 테이블 존재 여부
필드 매핑화면 표시 항목이 DB 컬럼으로 지원되는지
활용 화면 주석DB 테이블의 "활용 화면" 주석과 실제 화면 ID 일치

검증 방법:

  1. docs/화면_정의서.md에서 화면 ID, 기능 목록 추출
  2. docs/데이터베이스_정의서.md에서 테이블별 활용 화면 주석 추출
  3. 화면 기능 키워드 → 필요 테이블 매핑 확인

2. 기획서 ↔ 화면 정합성

프로젝트 기획서의 핵심 기능이 화면으로 구현되었는지 확인

검증 항목설명
기능 커버리지기획서 핵심 기능별 담당 화면 존재
플로우 일치기획서 사용자 플로우와 화면 연결 흐름 일치

검증 방법:

  1. docs/프로젝트_기획서.md에서 핵심 기능 목록 추출
  2. docs/화면_정의서.md에서 화면별 주요 기능 추출
  3. 기능 ↔ 화면 매핑 확인

3. API ↔ 화면/DB 정합성

API가 화면 기능을 지원하고 DB와 일관성 있는지 확인

검증 항목설명
화면별 필요 API화면 기능 수행에 필요한 API 엔드포인트 존재
API-DB 일관성API 응답 필드가 DB 스키마와 일치

검증 방법:

  1. docs/mvp/mvp_API_계약.md에서 API 엔드포인트 추출
  2. 화면 기능 → 필요 API 매핑 확인

4. 용어 일관성

문서 간 동일 개념에 대한 용어 통일 확인

검증 항목설명
화면 ID모든 문서에서 동일한 화면 ID 사용
테이블/필드명API와 DB 간 네이밍 일관성
기능 명칭동일 기능의 명칭 통일

실행 방법

/validate-docs

또는 특정 검증만 수행:

/validate-docs --check screen-db
/validate-docs --check plan-screen
/validate-docs --check api
/validate-docs --check terminology

리포트 형식

# 문서 정합성 검증 리포트

## 요약
- 총 검증 항목: N개
- 통과: N개
- 불일치: N개
- 경고: N개

## 불일치 상세

### [심각도] 카테고리
- 문서1: 내용
- 문서2: 내용
- 권장 조치: ...

주요 매핑 규칙

화면-DB 매핑 규칙은 references/validation_rules.md 참조

문서 위치

문서경로
화면 정의서docs/화면_정의서.md
DB 정의서docs/데이터베이스_정의서.md
프로젝트 기획서docs/프로젝트_기획서.md
API 계약서docs/mvp/mvp_API_계약.md
MVP 화면 정의서docs/mvp/mvp_화면_정의서.md
MVP DB 정의서docs/mvp/mvp_데이터베이스_정의서.md

Score

Total Score

45/100

Based on repository quality metrics

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

0/10
説明文

100文字以上の説明がある

0/10
人気

GitHub Stars 100以上

0/15
最近の活動

3ヶ月以内に更新がある

0/10
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

0/5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

0/5

Reviews

💬

Reviews coming soon