ballroom-flow-architecture-contract

Analyze Weave Steps architecture decisions and invariants before making changes.

Updated Jun 24, 2026
One-click install
npx skills add https://github.com/DanielMSchmidt/ballroom-flow --skill ballroom-flow-architecture-contract
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ballroom-flow-architecture-contract
Source: https://github.com/DanielMSchmidt/ballroom-flow/tree/main/.claude/skills/ballroom-flow-architecture-contract
Command: npx skills add https://github.com/DanielMSchmidt/ballroom-flow --skill ballroom-flow-architecture-contract

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a comprehensive understanding of the architecture decisions made for Weave Steps, ensuring changes to the system align with established guidelines.

Core Features & Use Cases

  • Architecture Overview: Summarizes the system's data shape, document boundaries, sync, permissions, and module structure.
  • Locked Decisions: Lists the key decisions made, their rationales, and how they are enforced.
  • Invariants: Outlines the invariants that must hold for any change to be merged.
  • Weak Points: Identifies known areas of the system that may require attention.
  • Subsystem Location: Maps out where each subsystem of the system lives within the codebase.
  • Use Case: Before making any change that touches data shape, boundaries, sync, permissions, or module structure in Weave Steps, use this Skill to ensure the change aligns with the established architecture.

Quick Start

Load the 'ballroom-flow-architecture-contract' skill to review the architecture decisions and invariants before making changes to Weave Steps.

Frequently Asked Questions about ballroom-flow-architecture-contract

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

FAQPage Schema
What are the architecture design decisions for Weave Steps data and document boundaries?

Before changing data shape, document boundaries, sync, permissions, or module structure in Weave Steps, you need a comprehensive understanding of the system's data model and design principles to ensure your modifications align with the established architecture guidelines and invariants.

How do I ensure my code changes align with Weave Steps architecture invariants?

To ensure code changes align with Weave Steps architecture, you must review the system's invariants and locked design decisions before making modifications. Any change to data shape, document boundaries, or module structure must hold true to these established architectural invariants to be merged.

What are the known weak points in the Weave Steps CRDT and sync architecture?

Known weak points in the Weave Steps architecture highlight specific system areas that may require attention during development. Reviewing these identified vulnerabilities helps developers anticipate potential issues when modifying data shape, Automerge CRDT sync, permissions, or document boundaries.

Where do Weave Steps subsystems live within the codebase?

Weave Steps subsystems live in mapped out locations within the codebase, detailing where each architectural component resides. This subsystem location mapping helps developers navigate the module structure before making changes to data shape, sync, or permissions.

Do I need prior knowledge of the data model to use the Weave Steps architecture contract?

Yes, applying the Weave Steps architecture contract requires existing knowledge of the system's data model and design principles. This prerequisite knowledge is necessary to properly evaluate whether your changes to data shape, sync, or document boundaries align with established guidelines.