搜索

PythonReactSEOPDF
GitHub Skill

validate-docs

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

jskjw157☆ 0 仓库 Stars0 仓库 Forks

安装与使用

请根据来源仓库和你的 AI 工具说明安装此技能。先阅读技能文件和依赖要求,再添加到工作流。

查看来源 ↗使用指南

技能说明

기획 문서 정합성 검증

개요

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

使用示例

查看来源仓库中的使用示例与配置说明。

查看来源 ↗

来源历史

收录时间
2026-01-20
索引更新时间
2026-01-26
Branch
main

收录与同步日期属于本站记录。源码修改历史请查看来源仓库。

GitHub ↗

chat Comments (0)

chat_bubble_outline

No comments yet. Be the first to share your thoughts!