본문으로 건너뛰기
cccskills
무료GitHub에 공개

check-docs

Check docs/ai/ spec files and ADRs for inconsistencies with the actual codebase. Report only, no modifications.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

설치 방법 보기

포함된 파일(1)

  • SKILL.md4.4 KB

SKILL.md(원문)

설치하기 전에 에이전트에게 전달되는 지시 내용을 확인할 수 있습니다.

Check Docs Consistency

Scan all documentation in docs/ai/, site docs, and app help for inconsistencies with the actual codebase. Do not modify any files.

Scope

Check these doc files against implementation:

Root docs

  1. README.md — project description, feature list, tech stack, project structure

AI / internal docs (docs/ai/)

  1. CLAUDE.md — project description, build commands, conventions, key architecture notes
  2. docs/ai/BACKLOG.md — check completed items against code, remove if done
  3. docs/ai/architecture.md — ADR statuses, component list, directory structure, commands
  4. docs/ai/overview.md — current state, non-goals
  5. docs/ai/sequencer-spec.md — Pattern/Track/Trig interfaces, playback behavior
  6. docs/ai/audio-interface.md — WorkletCommand, WorkletPattern, WorkletTrig, Engine API
  7. docs/ai/sound-design.md — voice params, paramDefs ranges/defaults
  8. docs/ai/ui-design.md — component descriptions, layout, mobile views
  9. docs/ai/glossary.md — term accuracy, missing terms
  10. docs/ai/DATA_MODEL.md — Song/Pattern/Cell/Track/Trig interfaces, relationships, mermaid ERD entity fields and classDiagram runtime state fields
  11. docs/ai/MESSAGE_FLOW.md — WorkletCommand flow, message protocol, signaling, mermaid sequence diagram function names
  12. docs/ai/adr/INDEX.md — ADR statuses (Implemented vs actual state)
  13. All ADR files marked as "Implemented" in INDEX.md — check against code

Site docs (site/src/content/docs/)

  1. All .mdx files under site/src/content/docs/docs/ (EN) and site/src/content/docs/ja/docs/ (JA) — tutorials, feature guides, getting-started pages
  2. Feature descriptions must match current implementation (e.g. number of FX slots, available parameters, signal flow)
  3. EN and JA versions must stay in sync with each other

App help (src/lib/components/SidebarHelp.svelte)

  1. Help card text — feature descriptions, parameter lists, workflow descriptions

Process

  1. Read all doc files listed above.

  2. Cross-reference with codebase by reading/grepping these key source files:

    • src/lib/types.ts — Song, Pattern, Cell, Trig, Track interfaces
    • src/lib/state.svelte.ts — reactive state shape
    • src/lib/audio/engine.ts — Engine API, patternToWorklet serialization
    • src/lib/audio/dsp/types.ts — WorkletCommand, WorkletPattern, WorkletTrig, WorkletInsertFx
    • src/lib/audio/worklet-processor.ts — WorkletCommand handling
    • src/lib/paramDefs.ts — voice parameter definitions (names, ranges, defaults)
    • src/lib/components/*.svelte — component names and existence
    • src/lib/audio/dsp/voices.ts — voice registry
    • src/lib/components/SidebarHelp.svelte — app help text
  3. Check for these types of inconsistencies:

    • Type/interface field mismatches (missing fields, wrong field names, wrong types)
    • Mermaid diagrams: treat erDiagram entity fields and classDiagram class fields as structured data — compare every field name, type, and description 1:1 against the source TypeScript interfaces (DATA_MODEL.md ERD vs types.ts, classDiagram vs state.svelte.ts, MESSAGE_FLOW.md sequence diagrams vs actual function names in scenePlayback.ts / engine.ts)
    • Wrong parameter ranges or defaults in docs vs paramDefs.ts
    • Components mentioned in docs that don't exist, or existing components not documented
    • ADR status mismatches (doc says PROPOSED but feature is implemented, or vice versa)
    • Removed/renamed features still documented
    • Missing documentation for implemented features
    • Stale line-number references to source files
  4. Output a report in this format:

## Docs Consistency Report

### [filename]
- **[section]**: [description of inconsistency]
  - Doc says: [what the doc states]
  - Code says: [what the code actually does]

### No issues found
- [filename] — OK

Guidelines

  • Use parallel Agent tools to speed up codebase exploration
  • Be thorough — check every interface field, every param range, every component reference
  • Only report confirmed inconsistencies, not stylistic preferences
  • Group findings by file for easy reference
  • This is a READ-ONLY operation — do not edit any files

리뷰

아직 리뷰가 없습니다. 사용해 본 소감을 남겨 주세요.

댓글

로그인 없이 쓸 수 있습니다. 사용 후기, 질문, 작동하지 않은 환경 등을 편하게 남겨 주세요.

아직 댓글이 없습니다. 첫 댓글을 남겨 보세요.

보내면 바로 공개됩니다. 이메일 주소나 전화번호 같은 개인 정보는 쓰지 마세요. URL은 2개까지입니다.

0 / 1,000자

이 양식은 reCAPTCHA로 보호되며 Google 개인정보처리방침 및 서비스 약관이 적용됩니다.

같은 저장소의 스킬

adr

무료

Create a new Architecture Decision Record (ADR) for a proposed feature or design change.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

im9/inboil22026년 10월 17일 업데이트

adr-done

무료

Mark an ADR as Implemented (or Superseded) and archive it, following INDEX.md conventions.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

im9/inboil22026년 10월 17일 업데이트

Scan the codebase for security vulnerabilities. Check OWASP top 10, input validation, auth, crypto, and known BACKLOG security items.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

im9/inboil22026년 10월 17일 업데이트

refactor

무료

Scan the project for refactoring opportunities, then fix them. No behavior/visual changes.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

im9/inboil22026년 10월 17일 업데이트

sync-docs

무료

Check docs/ai/ spec files and ADRs for inconsistencies with the codebase, then fix all discrepancies.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

im9/inboil22026년 10월 17일 업데이트

im9의 스킬 모두 보기

이 스킬의 문제 신고