architecture-sync

Detect architecture-sensitive changes and guide updates to docs/architecture.md.

Updated Feb 8, 2023
One-click install
npx skills add https://github.com/mvellandi/winky --skill architecture-sync
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: architecture-sync
Source: https://github.com/mvellandi/winky/tree/main/.agents/skills/architecture-sync
Command: npx skills add https://github.com/mvellandi/winky --skill architecture-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Use when a change may have moved module ownership, boundaries, or engine lifecycle responsibilities and the repo needs a review or update of docs/architecture.md.

Core Features & Use Cases

  • Detect changes that affect module ownership, boundaries, or lifecycle and flag when docs need review.
  • Guide updates to docs/architecture.md without modifying code.
  • Use Case: during a refactor, trigger a lightweight architecture review to confirm ownership and describe new boundaries in the canonical architecture map.

Quick Start

Run the architecture-sync workflow to inspect staged changes and update docs/architecture.md only when module ownership, boundaries, or lifecycle flows have changed.

Frequently Asked Questions about architecture-sync

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

FAQPage Schema
How do I keep architecture docs in sync with code changes during a refactor?

You can detect architecture-sensitive changes by executing node scripts/architecture-sync.js --mode=assist to assess staged changes. It flags shifts in module ownership, boundaries, or engine lifecycles that require reviewing docs/architecture.md.

When do I need to update docs/architecture.md based on module ownership shifts?

The architecture-sync workflow operates in an assist mode to read docs/architecture.md and related files, analyzing staged changes to enforce documentation updates only when module boundaries or lifecycle responsibilities actually change.

Can I use architecture-sync to modify code during a code review?

No, you cannot use architecture-sync to modify code. It guides updates to docs/architecture.md without modifying code, strictly focusing on keeping the canonical architecture map aligned during reviews and refactors.

What is the best way to flag architecture-sensitive changes before merging?

The best way to flag architecture-sensitive changes is to apply architecture-sync during code reviews. It reads related files to detect if module ownership or engine lifecycles shifted, prompting a lightweight architecture review before merging.