spec-sync

Align design docs with implemented code and file issues for divergences.

Updated Feb 27, 2025
One-click install
npx skills add https://github.com/tuanemuy/dotfiles --skill spec-sync-tuanemuy
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: spec-sync
Source: https://github.com/tuanemuy/dotfiles/tree/main/config/claude/skills/spec-sync
Command: npx skills add https://github.com/tuanemuy/dotfiles --skill spec-sync-tuanemuy

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

spec/ の設計ドキュメントと実装コードをレイヤー×ドメインの粒度で照合し、乖離を検出して解消する。実装の乖離を早期に露出させ、設計判断を反映する ADR を記録する。Issue対応やレビュー修正の後に発生する可能性のある乖離を積極的に洗い出す。

Core Features & Use Cases

  • レイヤー×ドメインの全体照合を自動的に計画・実行し、乖離を分類して要因を提示する。
  • 設計判断による変更を spec に反映し、ADR で追跡するワークフローを提供する。
  • 実装誤り・漏れが検出された場合は Issue として起票し、実装を修正せずに記録・共有する。

Quick Start

Run the end-to-end spec-sync flow to compare all layers, update specs to reflect current implementation, and file issues for any divergences.

Frequently Asked Questions about spec-sync

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep design docs aligned with implemented code automatically?

To keep design docs aligned with implemented code, spec-sync compares documentation against code across domain, adapter, use-case, frontend, and test layers to surface divergences and update ADRs.

What is the best way to detect divergences between specs and code after issue resolution?

Detecting divergences between specs and code after issue resolution requires an end-to-end alignment flow that classifies misalignments, records design decisions in ADRs, and files issues for implementation errors without modifying code.

How does ADR tracking work when implementation diverges from the original spec?

ADR tracking for implementation divergence works by reflecting current implementation changes into spec documents and recording the design decisions via ADRs to maintain traceability across all project layers.

Can I file issues for missing implementation without modifying the codebase directly?

Yes, you can file issues for missing implementation without modifying the codebase. spec-sync detects implementation errors and omissions, then creates issues to record and share them while delegating code changes to related workflows.

Does spec alignment work across all layers including frontend and tests?

Spec alignment applies globally across domain, adapter, use-case, frontend, and test layers, automatically planning and executing layer-by-domain comparisons to surface misalignments and present their underlying causes.

When should I not use automated spec synchronization?

You should not use automated spec synchronization when immediate code changes are required, because this workflow delegates code modifications to related workflows and focuses solely on spec updates, ADR recording, and issue creation.