learn-why-to-discuss-technical-design-before-implementation

Solid

Interactive guidance on creating technical design PRs to align with your team before coding.

AI & Automation 12 stars 0 forks Updated today MIT

Install

View on GitHub

Quality Score: 82/100

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

Skill Content

# Why Discuss Technical Design Before Implementation? ## Overview This learning module helps junior developers understand why creating a technical design PR before implementation leads to better outcomes, faster delivery, and reduced rework. ## Instructions Present the following content interactively. After each section, use `AskUserQuestion` to offer 3 options: - "Continue to next section" - "Show me an example" - "I have a question" --- ## Section 1: The Purpose of Technical Design PRs Explain that in story-flow, before writing implementation code, developers create a pull request containing their technical design: **A technical design PR serves three purposes:** 1. **Early feedback on approach** - Get team input before investing time in implementation 2. **Alignment before coding** - Ensure everyone agrees on the direction 3. **Living documentation** - The merged design becomes part of the repo history **The key insight:** > A technical design PR is not about seeking permission. It's about leveraging collective expertise to find the best solution before committing to an approach. **What gets included:** - Story requirements (from the story tracker, Figma analysis) - Planned tasks with execution order - Pseudo code, example payloads, or expected API responses - Questions or concerns for reviewers --- ## Section 2: The Shift-Left Concept Explain the "shift-left" principle: **Shift-left** means moving quality activities earlier in the development lifecycle. ...

Details

Author
Intai
Repository
Intai/story-flow
Created
7 months ago
Last Updated
today
Language
N/A
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category