@mohammadhprp/system-prompt 0.11.1 → 0.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/framework/agents/backend-architect.md +1 -1
- package/framework/agents/researcher.md +1 -1
- package/framework/mcps/figma-mcp-go/README.md +0 -1
- package/framework/mcps/github-mcp/README.md +1 -1
- package/framework/mcps/github-mcp/configs/.env.example +1 -1
- package/framework/mcps/gitlab-mcp/README.md +0 -1
- package/framework/mcps/jira-mcp/README.md +0 -1
- package/framework/mcps/laravel-boost/README.md +0 -1
- package/framework/mcps/notion-mcp/README.md +0 -1
- package/framework/mcps/supabase-mcp/README.md +0 -1
- package/framework/plugins/opencode-goal-plugin/README.md +0 -1
- package/framework/plugins/ponytail/README.md +1 -1
- package/framework/plugins/ponytail/capabilities.md +1 -1
- package/framework/references/standards/api.md +0 -1
- package/framework/references/standards/architecture.md +0 -1
- package/framework/references/standards/database.md +0 -1
- package/framework/references/standards/debugging.md +0 -1
- package/framework/references/standards/documentation.md +0 -2
- package/framework/references/standards/logging.md +0 -1
- package/framework/references/standards/naming.md +0 -1
- package/framework/references/standards/observability.md +0 -1
- package/framework/references/standards/performance.md +0 -1
- package/framework/references/standards/pull-requests.md +1 -2
- package/framework/references/standards/security.md +0 -1
- package/framework/references/standards/testing.md +0 -1
- package/framework/skills/README.md +16 -4
- package/framework/skills/codenavi/SKILL.md +306 -0
- package/framework/skills/codenavi/examples.md +33 -0
- package/framework/skills/codenavi/references/coding-principles.md +143 -0
- package/framework/skills/codenavi/references/notebook-spec.md +171 -0
- package/framework/skills/create-adr/SKILL.md +429 -0
- package/framework/skills/create-adr/examples.md +35 -0
- package/framework/skills/diagram-design/SKILL.md +1 -1
- package/framework/skills/docs-writer/SKILL.md +39 -0
- package/framework/skills/docs-writer/examples.md +34 -0
- package/framework/skills/docs-writer/references/style-guide.md +72 -0
- package/framework/skills/frontend-design/SKILL.md +55 -0
- package/framework/skills/frontend-design/examples.md +45 -0
- package/framework/skills/humanizer/SKILL.md +412 -0
- package/framework/skills/humanizer/examples.md +46 -0
- package/framework/skills/learning-opportunities/SKILL.md +140 -0
- package/framework/skills/learning-opportunities/examples.md +34 -0
- package/framework/skills/learning-opportunities/references/PRINCIPLES.md +42 -0
- package/framework/skills/perf-web-optimization/SKILL.md +163 -0
- package/framework/skills/perf-web-optimization/examples.md +35 -0
- package/framework/skills/perf-web-optimization/references/bundle-optimization.md +180 -0
- package/framework/skills/perf-web-optimization/references/core-web-vitals.md +154 -0
- package/framework/skills/perf-web-optimization/references/image-optimization.md +170 -0
- package/framework/skills/security-best-practices/LICENSE.txt +201 -0
- package/framework/skills/security-best-practices/SKILL.md +89 -0
- package/framework/skills/security-best-practices/examples.md +35 -0
- package/framework/skills/security-best-practices/references/golang-general-backend-security.md +988 -0
- package/framework/skills/security-best-practices/references/javascript-express-web-server-security.md +1151 -0
- package/framework/skills/security-best-practices/references/javascript-general-web-frontend-security.md +725 -0
- package/framework/skills/security-best-practices/references/javascript-jquery-web-frontend-security.md +672 -0
- package/framework/skills/security-best-practices/references/javascript-typescript-nextjs-web-server-security.md +1138 -0
- package/framework/skills/security-best-practices/references/javascript-typescript-react-web-frontend-security.md +975 -0
- package/framework/skills/security-best-practices/references/javascript-typescript-vue-web-frontend-security.md +789 -0
- package/framework/skills/security-best-practices/references/python-django-web-server-security.md +880 -0
- package/framework/skills/security-best-practices/references/python-fastapi-web-server-security.md +1030 -0
- package/framework/skills/security-best-practices/references/python-flask-web-server-security.md +835 -0
- package/framework/skills/sentry/SKILL.md +127 -0
- package/framework/skills/sentry/examples.md +34 -0
- package/framework/skills/sentry/scripts/sentry_api.py +238 -0
- package/framework/skills/show-me/SKILL.md +127 -0
- package/framework/skills/show-me/examples.md +78 -0
- package/framework/skills/spec-driven-eval/SKILL.md +341 -0
- package/framework/skills/spec-driven-eval/examples.md +35 -0
- package/framework/skills/spec-driven-eval/references/quickstart.md +118 -0
- package/framework/skills/spec-driven-eval/references/reference.md +295 -0
- package/framework/skills/taste/SKILL.md +47 -0
- package/framework/skills/taste/examples.md +73 -0
- package/framework/skills/taste/references/brandkit.md +793 -0
- package/framework/skills/taste/references/design-taste-frontend-v1.md +221 -0
- package/framework/skills/taste/references/design-taste-frontend.md +1201 -0
- package/framework/skills/taste/references/full-output-enforcement.md +44 -0
- package/framework/skills/taste/references/gpt-taste.md +69 -0
- package/framework/skills/taste/references/high-end-visual-design.md +93 -0
- package/framework/skills/taste/references/image-to-code.md +1223 -0
- package/framework/skills/taste/references/imagegen-frontend-mobile.md +1460 -0
- package/framework/skills/taste/references/imagegen-frontend-web.md +982 -0
- package/framework/skills/taste/references/industrial-brutalist-ui.md +87 -0
- package/framework/skills/taste/references/minimalist-ui.md +80 -0
- package/framework/skills/taste/references/redesign-existing-projects.md +173 -0
- package/framework/skills/taste/references/stitch-design-taste-design.md +121 -0
- package/framework/skills/taste/references/stitch-design-taste.md +179 -0
- package/framework/skills/technical-design-doc-creator/README.md +411 -0
- package/framework/skills/technical-design-doc-creator/SKILL.md +1484 -0
- package/framework/skills/technical-design-doc-creator/examples.md +35 -0
- package/framework/skills/tlc-spec-driven/SKILL.md +184 -0
- package/framework/skills/tlc-spec-driven/examples.md +34 -0
- package/framework/skills/tlc-spec-driven/references/code-analysis.md +98 -0
- package/framework/skills/tlc-spec-driven/references/coding-principles.md +72 -0
- package/framework/skills/tlc-spec-driven/references/context-limits.md +31 -0
- package/framework/skills/tlc-spec-driven/references/design.md +199 -0
- package/framework/skills/tlc-spec-driven/references/discuss.md +159 -0
- package/framework/skills/tlc-spec-driven/references/implement.md +436 -0
- package/framework/skills/tlc-spec-driven/references/lessons.md +115 -0
- package/framework/skills/tlc-spec-driven/references/memory.md +144 -0
- package/framework/skills/tlc-spec-driven/references/specify.md +228 -0
- package/framework/skills/tlc-spec-driven/references/sub-agents.md +147 -0
- package/framework/skills/tlc-spec-driven/references/tasks.md +451 -0
- package/framework/skills/tlc-spec-driven/references/validate.md +355 -0
- package/framework/skills/tlc-spec-driven/scripts/check_commit.py +115 -0
- package/framework/skills/tlc-spec-driven/scripts/lessons.py +412 -0
- package/framework/skills/tlc-spec-driven/scripts/validate_spec.py +260 -0
- package/framework/skills/tlc-spec-driven/scripts/validate_state.py +162 -0
- package/framework/skills/tlc-spec-driven/scripts/validate_tasks.py +251 -0
- package/framework/skills/web-design-guidelines/SKILL.md +65 -0
- package/framework/skills/web-design-guidelines/examples.md +32 -0
- package/framework/skills/web-design-guidelines/references/guideline.md +174 -0
- package/package.json +1 -1
- package/src/agent-configs.js +6 -2
- package/src/catalog.js +16 -3
- package/src/cli.js +82 -2
- package/src/doctor.js +84 -0
- package/src/installer.js +337 -154
- package/framework/skills/backend-engineer/SKILL.md +0 -76
- package/framework/skills/backend-engineer/examples.md +0 -31
- package/framework/skills/documentation/SKILL.md +0 -74
- package/framework/skills/documentation/examples.md +0 -31
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
# Stitch Design Taste — Semantic Design System Skill
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
This skill generates `DESIGN.md` files optimized for Google Stitch screen generation. It translates the battle-tested anti-slop frontend engineering directives into Stitch's native semantic design language — descriptive, natural-language rules paired with precise values that Stitch's AI agent can interpret to produce premium, non-generic interfaces.
|
|
5
|
+
|
|
6
|
+
The generated `DESIGN.md` serves as the **single source of truth** for prompting Stitch to generate new screens that align with a curated, high-agency design language. Stitch interprets design through **"Visual Descriptions"** supported by specific color values, typography specs, and component behaviors.
|
|
7
|
+
|
|
8
|
+
## Prerequisites
|
|
9
|
+
- Access to Google Stitch via [labs.google/stitch](https://labs.google/stitch)
|
|
10
|
+
- Optionally: Stitch MCP Server for programmatic integration with Cursor, Antigravity, or Gemini CLI
|
|
11
|
+
|
|
12
|
+
## The Goal
|
|
13
|
+
Generate a `DESIGN.md` file that encodes:
|
|
14
|
+
1. **Visual atmosphere** — the mood, density, and design philosophy
|
|
15
|
+
2. **Color calibration** — neutrals, accents, and banned patterns with hex codes
|
|
16
|
+
3. **Typographic architecture** — font stacks, scale hierarchy, and anti-patterns
|
|
17
|
+
4. **Component behaviors** — buttons, cards, inputs with interaction states
|
|
18
|
+
5. **Layout principles** — grid systems, spacing philosophy, responsive strategy
|
|
19
|
+
6. **Motion philosophy** — animation engine specs, spring physics, perpetual micro-interactions
|
|
20
|
+
7. **Anti-patterns** — explicit list of banned AI design clichés
|
|
21
|
+
|
|
22
|
+
## Analysis & Synthesis Instructions
|
|
23
|
+
|
|
24
|
+
### 1. Define the Atmosphere
|
|
25
|
+
Evaluate the target project's intent. Use evocative adjectives from the taste spectrum:
|
|
26
|
+
- **Density:** "Art Gallery Airy" (1–3) → "Daily App Balanced" (4–7) → "Cockpit Dense" (8–10)
|
|
27
|
+
- **Variance:** "Predictable Symmetric" (1–3) → "Offset Asymmetric" (4–7) → "Artsy Chaotic" (8–10)
|
|
28
|
+
- **Motion:** "Static Restrained" (1–3) → "Fluid CSS" (4–7) → "Cinematic Choreography" (8–10)
|
|
29
|
+
|
|
30
|
+
Default baseline: Variance 8, Motion 6, Density 4. Adapt dynamically based on user's vibe description.
|
|
31
|
+
|
|
32
|
+
### 2. Map the Color Palette
|
|
33
|
+
For each color provide: **Descriptive Name** + **Hex Code** + **Functional Role**.
|
|
34
|
+
|
|
35
|
+
**Mandatory constraints:**
|
|
36
|
+
- Maximum 1 accent color. Saturation below 80%
|
|
37
|
+
- The "AI Purple/Blue Neon" aesthetic is strictly BANNED — no purple button glows, no neon gradients
|
|
38
|
+
- Use absolute neutral bases (Zinc/Slate) with high-contrast singular accents
|
|
39
|
+
- Stick to one palette for the entire output — no warm/cool gray fluctuation
|
|
40
|
+
- Never use pure black (`#000000`) — use Off-Black, Zinc-950, or Charcoal
|
|
41
|
+
|
|
42
|
+
### 3. Establish Typography Rules
|
|
43
|
+
- **Display/Headlines:** Track-tight, controlled scale. Not screaming. Hierarchy through weight and color, not just massive size
|
|
44
|
+
- **Body:** Relaxed leading, max 65 characters per line
|
|
45
|
+
- **Font Selection:** `Inter` is BANNED for premium/creative contexts. Force unique character: `Geist`, `Outfit`, `Cabinet Grotesk`, or `Satoshi`
|
|
46
|
+
- **Serif Ban:** Generic serif fonts (`Times New Roman`, `Georgia`, `Garamond`, `Palatino`) are BANNED. If serif is needed for editorial/creative contexts, use only distinctive modern serifs: `Fraunces`, `Gambarino`, `Editorial New`, or `Instrument Serif`. Serif is always BANNED in dashboards or software UIs
|
|
47
|
+
- **Dashboard Constraint:** Use Sans-Serif pairings exclusively (`Geist` + `Geist Mono` or `Satoshi` + `JetBrains Mono`)
|
|
48
|
+
- **High-Density Override:** When density exceeds 7, all numbers must use Monospace
|
|
49
|
+
|
|
50
|
+
### 4. Define the Hero Section
|
|
51
|
+
The Hero is the first impression and must be creative, striking, and never generic:
|
|
52
|
+
- **Inline Image Typography:** Embed small, contextual photos or visuals directly between words or letters in the headline. Images sit inline at type-height, rounded, acting as visual punctuation. This is the signature creative technique
|
|
53
|
+
- **No Overlapping:** Text must never overlap images or other text. Every element occupies its own clean spatial zone
|
|
54
|
+
- **No Filler Text:** "Scroll to explore", "Swipe down", scroll arrow icons, bouncing chevrons are BANNED. The content should pull users in naturally
|
|
55
|
+
- **Asymmetric Structure:** Centered Hero layouts BANNED when variance exceeds 4
|
|
56
|
+
- **CTA Restraint:** Maximum one primary CTA. No secondary "Learn more" links
|
|
57
|
+
|
|
58
|
+
### 5. Describe Component Stylings
|
|
59
|
+
For each component type, describe shape, color, shadow depth, and interaction behavior:
|
|
60
|
+
- **Buttons:** Tactile push feedback on active state. No neon outer glows. No custom mouse cursors
|
|
61
|
+
- **Cards:** Use ONLY when elevation communicates hierarchy. Tint shadows to background hue. For high-density layouts, replace cards with border-top dividers or negative space
|
|
62
|
+
- **Inputs/Forms:** Label above input, helper text optional, error text below. Standard gap spacing
|
|
63
|
+
- **Loading States:** Skeletal loaders matching layout dimensions — no generic circular spinners
|
|
64
|
+
- **Empty States:** Composed compositions indicating how to populate data
|
|
65
|
+
- **Error States:** Clear, inline error reporting
|
|
66
|
+
|
|
67
|
+
### 6. Define Layout Principles
|
|
68
|
+
- No overlapping elements — every element occupies its own clear spatial zone. No absolute-positioned content stacking
|
|
69
|
+
- Centered Hero sections are BANNED when variance exceeds 4 — force Split Screen, Left-Aligned, or Asymmetric Whitespace
|
|
70
|
+
- The generic "3 equal cards horizontally" feature row is BANNED — use 2-column Zig-Zag, asymmetric grid, or horizontal scroll
|
|
71
|
+
- CSS Grid over Flexbox math — never use `calc()` percentage hacks
|
|
72
|
+
- Contain layouts using max-width constraints (e.g., 1400px centered)
|
|
73
|
+
- Full-height sections must use `min-h-[100dvh]` — never `h-screen` (iOS Safari catastrophic jump)
|
|
74
|
+
|
|
75
|
+
### 7. Define Responsive Rules
|
|
76
|
+
Every design must work across all viewports:
|
|
77
|
+
- **Mobile-First Collapse (< 768px):** All multi-column layouts collapse to single column. No exceptions
|
|
78
|
+
- **No Horizontal Scroll:** Horizontal overflow on mobile is a critical failure
|
|
79
|
+
- **Typography Scaling:** Headlines scale via `clamp()`. Body text minimum `1rem`/`14px`
|
|
80
|
+
- **Touch Targets:** All interactive elements minimum `44px` tap target
|
|
81
|
+
- **Image Behavior:** Inline typography images (photos between words) stack below headline on mobile
|
|
82
|
+
- **Navigation:** Desktop horizontal nav collapses to clean mobile menu
|
|
83
|
+
- **Spacing:** Vertical section gaps reduce proportionally (`clamp(3rem, 8vw, 6rem)`)
|
|
84
|
+
|
|
85
|
+
### 8. Encode Motion Philosophy
|
|
86
|
+
- **Spring Physics default:** `stiffness: 100, damping: 20` — premium, weighty feel. No linear easing
|
|
87
|
+
- **Perpetual Micro-Interactions:** Every active component should have an infinite loop state (Pulse, Typewriter, Float, Shimmer)
|
|
88
|
+
- **Staggered Orchestration:** Never mount lists instantly — use cascade delays for waterfall reveals
|
|
89
|
+
- **Performance:** Animate exclusively via `transform` and `opacity`. Never animate `top`, `left`, `width`, `height`. Grain/noise filters on fixed pseudo-elements only
|
|
90
|
+
|
|
91
|
+
### 9. List Anti-Patterns (AI Tells)
|
|
92
|
+
Encode these as explicit "NEVER DO" rules in the DESIGN.md:
|
|
93
|
+
- No emojis anywhere
|
|
94
|
+
- No `Inter` font
|
|
95
|
+
- No generic serif fonts (`Times New Roman`, `Georgia`, `Garamond`) — distinctive modern serifs only if needed
|
|
96
|
+
- No pure black (`#000000`)
|
|
97
|
+
- No neon/outer glow shadows
|
|
98
|
+
- No oversaturated accents
|
|
99
|
+
- No excessive gradient text on large headers
|
|
100
|
+
- No custom mouse cursors
|
|
101
|
+
- No overlapping elements — clean spatial separation always
|
|
102
|
+
- No 3-column equal card layouts
|
|
103
|
+
- No generic names ("John Doe", "Acme", "Nexus")
|
|
104
|
+
- No fake round numbers (`99.99%`, `50%`)
|
|
105
|
+
- No AI copywriting clichés ("Elevate", "Seamless", "Unleash", "Next-Gen")
|
|
106
|
+
- No filler UI text: "Scroll to explore", "Swipe down", scroll arrows, bouncing chevrons
|
|
107
|
+
- No broken Unsplash links — use `picsum.photos` or SVG avatars
|
|
108
|
+
- No centered Hero sections (for high-variance projects)
|
|
109
|
+
|
|
110
|
+
## Output Format (DESIGN.md Structure)
|
|
111
|
+
|
|
112
|
+
```markdown
|
|
113
|
+
# Design System: [Project Title]
|
|
114
|
+
|
|
115
|
+
## 1. Visual Theme & Atmosphere
|
|
116
|
+
(Evocative description of the mood, density, variance, and motion intensity.
|
|
117
|
+
Example: "A restrained, gallery-airy interface with confident asymmetric layouts
|
|
118
|
+
and fluid spring-physics motion. The atmosphere is clinical yet warm — like a
|
|
119
|
+
well-lit architecture studio.")
|
|
120
|
+
|
|
121
|
+
## 2. Color Palette & Roles
|
|
122
|
+
- **Canvas White** (#F9FAFB) — Primary background surface
|
|
123
|
+
- **Pure Surface** (#FFFFFF) — Card and container fill
|
|
124
|
+
- **Charcoal Ink** (#18181B) — Primary text, Zinc-950 depth
|
|
125
|
+
- **Muted Steel** (#71717A) — Secondary text, descriptions, metadata
|
|
126
|
+
- **Whisper Border** (rgba(226,232,240,0.5)) — Card borders, 1px structural lines
|
|
127
|
+
- **[Accent Name]** (#XXXXXX) — Single accent for CTAs, active states, focus rings
|
|
128
|
+
(Max 1 accent. Saturation < 80%. No purple/neon.)
|
|
129
|
+
|
|
130
|
+
## 3. Typography Rules
|
|
131
|
+
- **Display:** [Font Name] — Track-tight, controlled scale, weight-driven hierarchy
|
|
132
|
+
- **Body:** [Font Name] — Relaxed leading, 65ch max-width, neutral secondary color
|
|
133
|
+
- **Mono:** [Font Name] — For code, metadata, timestamps, high-density numbers
|
|
134
|
+
- **Banned:** Inter, generic system fonts for premium contexts. Serif fonts banned in dashboards.
|
|
135
|
+
|
|
136
|
+
## 4. Component Stylings
|
|
137
|
+
* **Buttons:** Flat, no outer glow. Tactile -1px translate on active. Accent fill for primary, ghost/outline for secondary.
|
|
138
|
+
* **Cards:** Generously rounded corners (2.5rem). Diffused whisper shadow. Used only when elevation serves hierarchy. High-density: replace with border-top dividers.
|
|
139
|
+
* **Inputs:** Label above, error below. Focus ring in accent color. No floating labels.
|
|
140
|
+
* **Loaders:** Skeletal shimmer matching exact layout dimensions. No circular spinners.
|
|
141
|
+
* **Empty States:** Composed, illustrated compositions — not just "No data" text.
|
|
142
|
+
|
|
143
|
+
## 5. Layout Principles
|
|
144
|
+
(Grid-first responsive architecture. Asymmetric splits for Hero sections.
|
|
145
|
+
Strict single-column collapse below 768px. Max-width containment.
|
|
146
|
+
No flexbox percentage math. Generous internal padding.)
|
|
147
|
+
|
|
148
|
+
## 6. Motion & Interaction
|
|
149
|
+
(Spring physics for all interactive elements. Staggered cascade reveals.
|
|
150
|
+
Perpetual micro-loops on active dashboard components. Hardware-accelerated
|
|
151
|
+
transforms only. Isolated Client Components for CPU-heavy animations.)
|
|
152
|
+
|
|
153
|
+
## 7. Anti-Patterns (Banned)
|
|
154
|
+
(Explicit list of forbidden patterns: no emojis, no Inter, no pure black,
|
|
155
|
+
no neon glows, no 3-column equal grids, no AI copywriting clichés,
|
|
156
|
+
no generic placeholder names, no broken image links.)
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
## Best Practices
|
|
160
|
+
- **Be Descriptive:** "Deep Charcoal Ink (#18181B)" — not just "dark text"
|
|
161
|
+
- **Be Functional:** Explain what each element is used for
|
|
162
|
+
- **Be Consistent:** Same terminology throughout the document
|
|
163
|
+
- **Be Precise:** Include exact hex codes, rem values, pixel values in parentheses
|
|
164
|
+
- **Be Opinionated:** This is not a neutral template — it enforces a specific, premium aesthetic
|
|
165
|
+
|
|
166
|
+
## Tips for Success
|
|
167
|
+
1. Start with the atmosphere — understand the vibe before detailing tokens
|
|
168
|
+
2. Look for patterns — identify consistent spacing, sizing, and styling
|
|
169
|
+
3. Think semantically — name colors by purpose, not just appearance
|
|
170
|
+
4. Consider hierarchy — document how visual weight communicates importance
|
|
171
|
+
5. Encode the bans — anti-patterns are as important as the rules themselves
|
|
172
|
+
|
|
173
|
+
## Common Pitfalls to Avoid
|
|
174
|
+
- Using technical jargon without translation ("rounded-xl" instead of "generously rounded corners")
|
|
175
|
+
- Omitting hex codes or using only descriptive names
|
|
176
|
+
- Forgetting functional roles of design elements
|
|
177
|
+
- Being too vague in atmosphere descriptions
|
|
178
|
+
- Ignoring the anti-pattern list — these are what make the output premium
|
|
179
|
+
- Defaulting to generic "safe" designs instead of enforcing the curated aesthetic
|
|
@@ -0,0 +1,411 @@
|
|
|
1
|
+
# Technical Design Doc Creator
|
|
2
|
+
|
|
3
|
+
A skill for AI coding agents that helps create comprehensive Technical Design Documents (TDDs) following industry standards.
|
|
4
|
+
|
|
5
|
+
## What It Does
|
|
6
|
+
|
|
7
|
+
This skill guides AI agents to create well-structured Technical Design Documents that include:
|
|
8
|
+
|
|
9
|
+
- **Mandatory sections**: Context, Problem Statement, Scope, Technical Solution, Risks, Implementation Plan
|
|
10
|
+
- **Critical sections**: Security (for payments/auth), Monitoring, Rollback Plan, Testing Strategy
|
|
11
|
+
- **Optional sections**: Success Metrics, Glossary, Alternatives Considered, Dependencies, Performance Requirements, and more
|
|
12
|
+
|
|
13
|
+
The skill automatically adapts to:
|
|
14
|
+
|
|
15
|
+
- **Project size**: Small (< 1 week), Medium (1-4 weeks), Large (> 1 month)
|
|
16
|
+
- **Project type**: Integration, Feature, Refactor, Infrastructure, Payment, Auth, Data migration
|
|
17
|
+
- **User's language**: Automatically generates TDD in Portuguese, English, or Spanish based on your request
|
|
18
|
+
|
|
19
|
+
## How to Use
|
|
20
|
+
|
|
21
|
+
### Basic Usage
|
|
22
|
+
|
|
23
|
+
Simply ask the AI agent to create a TDD:
|
|
24
|
+
|
|
25
|
+
**English:**
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
Create a TDD for Stripe payment integration
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
**Portuguese:**
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
Crie um TDD para integração com Stripe
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
**Spanish:**
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
Crea un TDD para integración con Stripe
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### Interactive Workflow
|
|
44
|
+
|
|
45
|
+
The skill will guide you through an interactive process:
|
|
46
|
+
|
|
47
|
+
1. **Initial Questions**: Project name, size, type, and context clarity
|
|
48
|
+
2. **Mandatory Information**: Problem statement, scope, technical approach
|
|
49
|
+
3. **Critical Sections**: Security, monitoring, rollback (if applicable)
|
|
50
|
+
4. **Optional Sections**: Success metrics, glossary, alternatives, etc.
|
|
51
|
+
|
|
52
|
+
### Examples
|
|
53
|
+
|
|
54
|
+
#### Example 1: Payment Integration
|
|
55
|
+
|
|
56
|
+
**Your Request:**
|
|
57
|
+
|
|
58
|
+
```
|
|
59
|
+
Create a TDD for integrating Stripe payments into our subscription system
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
**What Happens:**
|
|
63
|
+
|
|
64
|
+
1. Agent asks about project size and type
|
|
65
|
+
2. Agent requests: problem statement, scope, technical approach
|
|
66
|
+
3. Agent identifies this is a payment system → **Security section becomes MANDATORY**
|
|
67
|
+
4. Agent asks for: security requirements, monitoring metrics, rollback plan
|
|
68
|
+
5. Agent generates comprehensive TDD with all required sections
|
|
69
|
+
|
|
70
|
+
**Result:** A complete TDD with:
|
|
71
|
+
|
|
72
|
+
- Context and problem statement
|
|
73
|
+
- In-scope/out-of-scope features
|
|
74
|
+
- Architecture diagram
|
|
75
|
+
- API contracts
|
|
76
|
+
- Security considerations (PCI DSS compliance, encryption, PII handling)
|
|
77
|
+
- Testing strategy
|
|
78
|
+
- Monitoring & observability
|
|
79
|
+
- Rollback plan
|
|
80
|
+
- Implementation timeline
|
|
81
|
+
|
|
82
|
+
#### Example 2: Simple Feature
|
|
83
|
+
|
|
84
|
+
**Your Request:**
|
|
85
|
+
|
|
86
|
+
```
|
|
87
|
+
Write a design doc for adding user profile pictures
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
**What Happens:**
|
|
91
|
+
|
|
92
|
+
1. Agent identifies this as a small feature
|
|
93
|
+
2. Agent asks for basic information
|
|
94
|
+
3. Agent generates streamlined TDD with essential sections only
|
|
95
|
+
|
|
96
|
+
**Result:** A focused TDD with:
|
|
97
|
+
|
|
98
|
+
- Context
|
|
99
|
+
- Problem statement
|
|
100
|
+
- Scope (in/out)
|
|
101
|
+
- Technical solution (file upload, storage, API endpoints)
|
|
102
|
+
- Risks
|
|
103
|
+
- Implementation plan
|
|
104
|
+
- Testing strategy
|
|
105
|
+
|
|
106
|
+
#### Example 3: Migration Project
|
|
107
|
+
|
|
108
|
+
**Your Request:**
|
|
109
|
+
|
|
110
|
+
```
|
|
111
|
+
Crie um TDD para migração do banco de dados PostgreSQL para MongoDB
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
**What Happens:**
|
|
115
|
+
|
|
116
|
+
1. Agent detects Portuguese language → generates TDD in Portuguese
|
|
117
|
+
2. Agent identifies this as a migration project
|
|
118
|
+
3. Agent requests: migration strategy, data mapping, rollback plan
|
|
119
|
+
4. Agent offers migration plan section
|
|
120
|
+
|
|
121
|
+
**Result:** A TDD in Portuguese with:
|
|
122
|
+
|
|
123
|
+
- Contexto (Context)
|
|
124
|
+
- Definição do Problema (Problem Statement)
|
|
125
|
+
- Escopo (Scope)
|
|
126
|
+
- Solução Técnica (Technical Solution)
|
|
127
|
+
- Plano de Migração (Migration Plan)
|
|
128
|
+
- Plano de Rollback (Rollback Plan)
|
|
129
|
+
- Estratégia de Testes (Testing Strategy)
|
|
130
|
+
|
|
131
|
+
## What to Expect
|
|
132
|
+
|
|
133
|
+
### The Agent Will Ask Questions
|
|
134
|
+
|
|
135
|
+
The skill is designed to gather complete information. Expect questions like:
|
|
136
|
+
|
|
137
|
+
**For Problem Statement:**
|
|
138
|
+
|
|
139
|
+
- What problem are we solving?
|
|
140
|
+
- Why is this important now?
|
|
141
|
+
- What happens if we don't solve it?
|
|
142
|
+
|
|
143
|
+
**For Scope:**
|
|
144
|
+
|
|
145
|
+
- What WILL be delivered in V1?
|
|
146
|
+
- What will NOT be included (out of scope)?
|
|
147
|
+
|
|
148
|
+
**For Technical Approach:**
|
|
149
|
+
|
|
150
|
+
- What are the main components?
|
|
151
|
+
- How does data flow through the system?
|
|
152
|
+
- What APIs will be created/modified?
|
|
153
|
+
|
|
154
|
+
**For Payment/Auth Projects:**
|
|
155
|
+
|
|
156
|
+
- How will you handle authentication?
|
|
157
|
+
- What encryption will be used?
|
|
158
|
+
- What PII is collected?
|
|
159
|
+
- Any compliance requirements (GDPR, PCI DSS)?
|
|
160
|
+
|
|
161
|
+
**For Production Systems:**
|
|
162
|
+
|
|
163
|
+
- How will you monitor this?
|
|
164
|
+
- What metrics matter?
|
|
165
|
+
- How will you rollback if something fails?
|
|
166
|
+
|
|
167
|
+
### The Generated TDD
|
|
168
|
+
|
|
169
|
+
The TDD will include:
|
|
170
|
+
|
|
171
|
+
1. **Header & Metadata**: Tech Lead, Team, Epic link, Status, Dates
|
|
172
|
+
2. **Context**: Background, domain, stakeholders
|
|
173
|
+
3. **Problem Statement**: Specific problems with quantified impact
|
|
174
|
+
4. **Scope**: Clear in-scope and out-of-scope items
|
|
175
|
+
5. **Technical Solution**: Architecture, data flow, APIs, database changes
|
|
176
|
+
6. **Risks**: Risk matrix with impact, probability, and mitigation
|
|
177
|
+
7. **Implementation Plan**: Phased breakdown with estimates
|
|
178
|
+
8. **Security** (if applicable): Authentication, encryption, compliance
|
|
179
|
+
9. **Testing Strategy**: Unit, integration, E2E test plans
|
|
180
|
+
10. **Monitoring & Observability**: Metrics, alerts, dashboards
|
|
181
|
+
11. **Rollback Plan**: Triggers and steps for reverting changes
|
|
182
|
+
12. **Optional sections**: Success metrics, glossary, alternatives, dependencies, etc.
|
|
183
|
+
|
|
184
|
+
## Tips for Best Results
|
|
185
|
+
|
|
186
|
+
### 1. Provide Context Early
|
|
187
|
+
|
|
188
|
+
Instead of:
|
|
189
|
+
|
|
190
|
+
```
|
|
191
|
+
Create a TDD for Stripe
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
Try:
|
|
195
|
+
|
|
196
|
+
```
|
|
197
|
+
Create a TDD for integrating Stripe payments. We need to support subscriptions,
|
|
198
|
+
handle webhooks, and comply with PCI DSS. This is for our SaaS product.
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
### 2. Be Specific About Scope
|
|
202
|
+
|
|
203
|
+
The agent will ask, but you can provide upfront:
|
|
204
|
+
|
|
205
|
+
```
|
|
206
|
+
Create a TDD for user authentication. In scope: email/password, JWT tokens,
|
|
207
|
+
password reset. Out of scope: OAuth, 2FA, social login (those are V2).
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
### 3. Mention Project Size
|
|
211
|
+
|
|
212
|
+
```
|
|
213
|
+
Create a TDD for the database migration project. This is a large project
|
|
214
|
+
(expected 2 months).
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
### 4. Specify Critical Requirements
|
|
218
|
+
|
|
219
|
+
For payment/auth systems, mention security requirements:
|
|
220
|
+
|
|
221
|
+
```
|
|
222
|
+
Create a TDD for Stripe integration. We need PCI DSS compliance, webhook
|
|
223
|
+
signature validation, and encrypted storage of payment method tokens.
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
### 5. Use Your Language
|
|
227
|
+
|
|
228
|
+
The skill automatically detects your language. Just write naturally:
|
|
229
|
+
|
|
230
|
+
- **English**: "Create a TDD for..."
|
|
231
|
+
- **Portuguese**: "Crie um TDD para..."
|
|
232
|
+
- **Spanish**: "Crea un TDD para..."
|
|
233
|
+
|
|
234
|
+
## Language Support
|
|
235
|
+
|
|
236
|
+
The skill supports multiple languages:
|
|
237
|
+
|
|
238
|
+
| Language | Example Trigger |
|
|
239
|
+
| ---------- | ----------------------------------------- |
|
|
240
|
+
| English | "Create a TDD for Stripe integration" |
|
|
241
|
+
| Portuguese | "Crie um TDD para integração com Stripe" |
|
|
242
|
+
| Spanish | "Crea un TDD para integración con Stripe" |
|
|
243
|
+
|
|
244
|
+
All section headers and content are automatically translated to match your language.
|
|
245
|
+
|
|
246
|
+
## Integration with Other Skills
|
|
247
|
+
|
|
248
|
+
### Confluence Publishing
|
|
249
|
+
|
|
250
|
+
After generating a TDD, the agent will offer to publish it to Confluence:
|
|
251
|
+
|
|
252
|
+
```
|
|
253
|
+
Would you like me to publish this TDD to Confluence?
|
|
254
|
+
- I can create a new page in your space
|
|
255
|
+
- Or update an existing page
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
### Jira Integration
|
|
259
|
+
|
|
260
|
+
The TDD includes a metadata section for Epic/Ticket links. You can manually add these or ask the agent to help create Jira tickets.
|
|
261
|
+
|
|
262
|
+
## What Makes This Skill Different
|
|
263
|
+
|
|
264
|
+
### 1. Industry Standards
|
|
265
|
+
|
|
266
|
+
Follows patterns from:
|
|
267
|
+
|
|
268
|
+
- Google Design Docs
|
|
269
|
+
- Amazon PR-FAQ (Working Backwards)
|
|
270
|
+
- RFC Pattern
|
|
271
|
+
- ADR (Architecture Decision Records)
|
|
272
|
+
- SRE Book (Monitoring, Rollback, SLOs)
|
|
273
|
+
- PCI DSS & OWASP (Security)
|
|
274
|
+
|
|
275
|
+
### 2. Architecture-Focused, Not Implementation
|
|
276
|
+
|
|
277
|
+
The TDD documents **decisions and contracts**, not code:
|
|
278
|
+
|
|
279
|
+
✅ **Includes**: API contracts, data schemas, architecture diagrams, strategies
|
|
280
|
+
❌ **Avoids**: CLI commands, code snippets, framework-specific implementation
|
|
281
|
+
|
|
282
|
+
### 3. Adaptive to Project Size
|
|
283
|
+
|
|
284
|
+
- **Small projects**: Essential sections only (7-9 sections)
|
|
285
|
+
- **Medium projects**: Mandatory + critical sections (11-13 sections)
|
|
286
|
+
- **Large projects**: All sections (up to 20 sections)
|
|
287
|
+
|
|
288
|
+
### 4. Mandatory Sections Enforcement
|
|
289
|
+
|
|
290
|
+
The agent will **insist** on completing mandatory sections before finalizing the TDD. You can't skip:
|
|
291
|
+
|
|
292
|
+
- Problem Statement
|
|
293
|
+
- Scope
|
|
294
|
+
- Technical Solution
|
|
295
|
+
- Risks
|
|
296
|
+
- Implementation Plan
|
|
297
|
+
|
|
298
|
+
### 5. Critical Sections for Specific Project Types
|
|
299
|
+
|
|
300
|
+
- **Payment/Auth**: Security section is MANDATORY
|
|
301
|
+
- **Production**: Monitoring and Rollback are MANDATORY
|
|
302
|
+
- **Integration**: Dependencies and Security are highly recommended
|
|
303
|
+
|
|
304
|
+
## Common Use Cases
|
|
305
|
+
|
|
306
|
+
### ✅ Good Use Cases
|
|
307
|
+
|
|
308
|
+
- New feature development
|
|
309
|
+
- External API integration
|
|
310
|
+
- System migration or refactoring
|
|
311
|
+
- Infrastructure changes
|
|
312
|
+
- Payment/billing system design
|
|
313
|
+
- Authentication/authorization system
|
|
314
|
+
- Data processing pipelines
|
|
315
|
+
|
|
316
|
+
### ❌ Not Ideal For
|
|
317
|
+
|
|
318
|
+
- Bug fixes (too small)
|
|
319
|
+
- Code refactoring without architectural changes
|
|
320
|
+
- Documentation updates
|
|
321
|
+
- Simple configuration changes
|
|
322
|
+
|
|
323
|
+
## Example Output Structure
|
|
324
|
+
|
|
325
|
+
```
|
|
326
|
+
# TDD - [Project Name]
|
|
327
|
+
|
|
328
|
+
## Metadata
|
|
329
|
+
- Tech Lead: @Name
|
|
330
|
+
- Team: Name1, Name2
|
|
331
|
+
- Status: Draft
|
|
332
|
+
- Created: 2026-02-04
|
|
333
|
+
|
|
334
|
+
## Context
|
|
335
|
+
[Background and domain description]
|
|
336
|
+
|
|
337
|
+
## Problem Statement & Motivation
|
|
338
|
+
[Specific problems with impact]
|
|
339
|
+
|
|
340
|
+
## Scope
|
|
341
|
+
### ✅ In Scope
|
|
342
|
+
[What will be delivered]
|
|
343
|
+
|
|
344
|
+
### ❌ Out of Scope
|
|
345
|
+
[What won't be included]
|
|
346
|
+
|
|
347
|
+
## Technical Solution
|
|
348
|
+
[Architecture, APIs, data flow, database changes]
|
|
349
|
+
|
|
350
|
+
## Risks
|
|
351
|
+
[Risk matrix with mitigation]
|
|
352
|
+
|
|
353
|
+
## Implementation Plan
|
|
354
|
+
[Phased breakdown with estimates]
|
|
355
|
+
|
|
356
|
+
## Security Considerations
|
|
357
|
+
[Authentication, encryption, compliance]
|
|
358
|
+
|
|
359
|
+
## Testing Strategy
|
|
360
|
+
[Unit, integration, E2E tests]
|
|
361
|
+
|
|
362
|
+
## Monitoring & Observability
|
|
363
|
+
[Metrics, alerts, dashboards]
|
|
364
|
+
|
|
365
|
+
## Rollback Plan
|
|
366
|
+
[Triggers and steps]
|
|
367
|
+
|
|
368
|
+
[Additional optional sections...]
|
|
369
|
+
```
|
|
370
|
+
|
|
371
|
+
## Troubleshooting
|
|
372
|
+
|
|
373
|
+
### The Agent Keeps Asking Questions
|
|
374
|
+
|
|
375
|
+
**This is normal!** The skill is designed to gather complete information. Answer the questions to get a comprehensive TDD.
|
|
376
|
+
|
|
377
|
+
### I Want to Skip a Section
|
|
378
|
+
|
|
379
|
+
Mandatory sections cannot be skipped. For optional sections, you can say:
|
|
380
|
+
|
|
381
|
+
```
|
|
382
|
+
Skip the Alternatives Considered section for now
|
|
383
|
+
```
|
|
384
|
+
|
|
385
|
+
### The TDD is Too Detailed
|
|
386
|
+
|
|
387
|
+
For small projects, specify the size:
|
|
388
|
+
|
|
389
|
+
```
|
|
390
|
+
This is a small project (< 1 week), keep it simple
|
|
391
|
+
```
|
|
392
|
+
|
|
393
|
+
### The TDD is Missing Something
|
|
394
|
+
|
|
395
|
+
Tell the agent what's missing:
|
|
396
|
+
|
|
397
|
+
```
|
|
398
|
+
Add a section on performance requirements
|
|
399
|
+
```
|
|
400
|
+
|
|
401
|
+
## Next Steps After Creating a TDD
|
|
402
|
+
|
|
403
|
+
1. **Review**: Check all sections are complete
|
|
404
|
+
2. **Share**: Get feedback from team members
|
|
405
|
+
3. **Approve**: Get sign-off from stakeholders
|
|
406
|
+
4. **Implement**: Use the TDD as a guide during development
|
|
407
|
+
5. **Update**: Keep the TDD updated as the project evolves
|
|
408
|
+
|
|
409
|
+
## Support
|
|
410
|
+
|
|
411
|
+
For issues or questions about this skill, refer to the main [agent-skills repository](https://github.com/tech-leads-club/agent-skills).
|