arch-create

Create and update architecture docs defining system boundaries, contracts, and design tradeoffs.

Updated Nov 7, 2024
One-click install
npx skills add https://github.com/jeremysball/dotfiles --skill arch-create-jeremysball
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: arch-create
Source: https://github.com/jeremysball/dotfiles/tree/main/.pi/skills-archive/arch-create
Command: npx skills add https://github.com/jeremysball/dotfiles --skill arch-create-jeremysball

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Design decisions often get buried inside PRDs or scattered across conversations, leaving no durable source of truth for system boundaries and contracts. This Skill guides the creation of first-class architecture documents that capture system shape, constraints, and tradeoffs so downstream PRDs can reference them instead of re-explaining the design. ## Core Features & Use Cases - Structured Architecture Doc Workflow: Walks through scoping, reviewing existing docs, choosing a canonical path under docs/architecture/, and drafting section by section using a proven template. - Architecture vs PRD Separation: Enforces a clear distinction between design docs (boundaries, contracts, tradeoffs) and PRDs (product intent, scope, milestones), with guidance on when to use each. - Downstream Linking and Handoff: Identifies PRDs that should reference the new doc and offers next-step options to create a PRD or commit the doc directly to main. - Use Case: A team is redesigning a runtime adjudication boundary. Use this Skill to produce docs/architecture/support-runtime-adjudication.md capturing the chosen design, rejected alternatives, and migration plan, then hand off implementation to a PRD. ## Quick Start Ask the assistant to create an architecture doc for your proposed system design, describing the boundary or contract that is changing.

Frequently Asked Questions about arch-create

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

FAQPage Schema
How do I write an architecture design doc for a system change?

Start by defining the boundary or contract that is changing, review existing architecture docs, then draft section by section covering problem, goals, options considered, chosen design, contracts, migration, and validation. This Skill provides a full template and discussion questions to guide the process.

What is the difference between an architecture doc and a PRD?

An architecture doc captures system shape, boundaries, contracts, constraints, and tradeoffs, while a PRD covers product intent, user-visible behavior, scope, and milestones. Architecture docs serve as the durable design source of truth that PRDs reference.

When should I update an existing architecture doc instead of creating a new one?

Update an existing doc when it already owns the boundary or contract being changed. Create a new doc under docs/architecture/ only when the design deserves its own durable source of truth with a short, stable slug.

What sections should an architecture decision document include?

Include status, problem, goals, non-goals, current constraints, options considered, chosen design, boundary and contract details, data and control flow, migration plan, validation strategy, and risks. The Skill provides this as a ready-to-adapt Markdown template.

Should architecture changes be tracked as GitHub issues?

Not by default. This Skill commits docs-only architecture changes directly to main with a [skip ci] flag and only creates GitHub issues if the user explicitly requests issue-based tracking.