architectural-proposals

Featured

How to write comprehensive architectural proposals that drive alignment before code is written

AI & Automation 5,125 stars 539 forks Updated today MIT

Install

View on GitHub

Quality Score: 96/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

## Context Proposals create alignment before code is written. Cheaper to change a doc than refactor code. Use this pattern when: - Architecture shifts invalidate existing assumptions - Product direction changes require new foundation - Multiple waves/milestones will be affected by a decision - External dependencies (Copilot CLI, SDK APIs) change ## Patterns ### Proposal Structure (docs/proposals/) **Required sections:** 1. **Problem Statement** — Why current state is broken (specific, measurable evidence) 2. **Proposed Architecture** — Solution with technical specifics (not hand-waving) 3. **What Changes** — Impact on existing work (waves, milestones, modules) 4. **What Stays the Same** — Preserve existing functionality (no regression) 5. **Key Decisions Needed** — Explicit choices with recommendations 6. **Risks and Mitigations** — Likelihood + impact + mitigation strategy 7. **Scope** — What's in v1, what's deferred (timeline clarity) **Optional sections:** - Implementation Plan (high-level milestones) - Success Criteria (measurable outcomes) - Open Questions (unresolved items) - Appendix (prior art, alternatives considered) ### Tone Ceiling Enforcement **Always:** - Cite specific evidence (user reports, performance data, failure modes) - Justify recommendations with technical rationale - Acknowledge trade-offs (no perfect solutions) - Be specific about APIs, libraries, file paths **Never:** - Hype ("revolutionary", "game-changing") - Hand-waving ("we'll figure it o...

Details

Author
github
Repository
github/gh-aw
Created
1 years ago
Last Updated
today
Language
Go
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category