design

Featured

Writes a clear spec for a proposed feature or system change. Use when important product or technical choices must be settled before coding. Covers behavior, interfaces, failures, risks, acceptance criteria, and tests. Use architecture to explain the current system.

Web & Frontend 390 stars 68 forks Updated 4 days ago MIT

Install

View on GitHub

Quality Score: 93/100

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

Skill Content

# Design ## Workflow 1. Read the request, repository instructions, relevant code, and linked material. 2. Resolve choices that would change behavior, interfaces, data, errors, security, operations, or tests. 3. Ask only questions whose answers would change the design. Recommend an answer when asking. 4. Write `docs/<feature-slug>/design.md` using the numbered shape below. Keep it short and in order. Omit only sections that do not apply. 5. Run the review pass. Fix what you can. List the rest under Open questions. 6. Stop with the proposed design ready for review. Do not plan or implement it. ## Document shape ```markdown # <Title> > **Status:** Proposed for review ## 1. Executive summary Say what is wrong today, who feels the problem, what will change, how we plan to fix it, and the main downside. Use simple words. Do not list sections or implementation details. ## 2. Context and scope Describe the current behavior, why it is insufficient, what changes once this ships, and the boundary of this design. ## 3. System context Show where the change fits in the current system. Name the parts and outside systems it touches and the boundaries it must preserve. Include a small diagram when it makes those relationships clearer. ## 4. Proposed design ### How it works Walk one real case from start to finish. Name the thing that arrives, what handles it, what gets written down, and what the user sees. ### Components and responsibilities For each changed part, state what it owns...

Details

Author
owainlewis
Repository
owainlewis/blueprint
Created
6 months ago
Last Updated
4 days ago
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category