musubi-sdd 0.1.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.
Files changed (91) hide show
  1. package/LICENSE +21 -0
  2. package/README.ja.md +531 -0
  3. package/README.md +531 -0
  4. package/bin/musubi-init.js +321 -0
  5. package/bin/musubi.js +359 -0
  6. package/package.json +55 -0
  7. package/src/agents/registry.js +242 -0
  8. package/src/templates/agents/claude-code/CLAUDE.md +232 -0
  9. package/src/templates/agents/claude-code/commands/sdd-design.md +673 -0
  10. package/src/templates/agents/claude-code/commands/sdd-implement.md +777 -0
  11. package/src/templates/agents/claude-code/commands/sdd-requirements.md +438 -0
  12. package/src/templates/agents/claude-code/commands/sdd-steering.md +334 -0
  13. package/src/templates/agents/claude-code/commands/sdd-tasks.md +582 -0
  14. package/src/templates/agents/claude-code/commands/sdd-validate.md +710 -0
  15. package/src/templates/agents/claude-code/skills/ai-ml-engineer/SKILL.md +3055 -0
  16. package/src/templates/agents/claude-code/skills/api-designer/SKILL.md +1364 -0
  17. package/src/templates/agents/claude-code/skills/bug-hunter/SKILL.md +482 -0
  18. package/src/templates/agents/claude-code/skills/change-impact-analyzer/SKILL.md +397 -0
  19. package/src/templates/agents/claude-code/skills/cloud-architect/SKILL.md +1468 -0
  20. package/src/templates/agents/claude-code/skills/code-reviewer/SKILL.md +906 -0
  21. package/src/templates/agents/claude-code/skills/constitution-enforcer/SKILL.md +466 -0
  22. package/src/templates/agents/claude-code/skills/database-administrator/SKILL.md +3522 -0
  23. package/src/templates/agents/claude-code/skills/database-schema-designer/SKILL.md +1158 -0
  24. package/src/templates/agents/claude-code/skills/devops-engineer/SKILL.md +647 -0
  25. package/src/templates/agents/claude-code/skills/orchestrator/SKILL.md +574 -0
  26. package/src/templates/agents/claude-code/skills/performance-optimizer/SKILL.md +464 -0
  27. package/src/templates/agents/claude-code/skills/project-manager/SKILL.md +769 -0
  28. package/src/templates/agents/claude-code/skills/quality-assurance/SKILL.md +1059 -0
  29. package/src/templates/agents/claude-code/skills/release-coordinator/SKILL.md +653 -0
  30. package/src/templates/agents/claude-code/skills/requirements-analyst/SKILL.md +1287 -0
  31. package/src/templates/agents/claude-code/skills/security-auditor/SKILL.md +1107 -0
  32. package/src/templates/agents/claude-code/skills/site-reliability-engineer/SKILL.md +404 -0
  33. package/src/templates/agents/claude-code/skills/software-developer/SKILL.md +1254 -0
  34. package/src/templates/agents/claude-code/skills/steering/SKILL.md +383 -0
  35. package/src/templates/agents/claude-code/skills/system-architect/SKILL.md +1288 -0
  36. package/src/templates/agents/claude-code/skills/technical-writer/SKILL.md +712 -0
  37. package/src/templates/agents/claude-code/skills/test-engineer/SKILL.md +1262 -0
  38. package/src/templates/agents/claude-code/skills/traceability-auditor/SKILL.md +298 -0
  39. package/src/templates/agents/claude-code/skills/ui-ux-designer/SKILL.md +1009 -0
  40. package/src/templates/agents/codex/AGENTS.md +138 -0
  41. package/src/templates/agents/codex/commands/sdd-design.md +673 -0
  42. package/src/templates/agents/codex/commands/sdd-implement.md +777 -0
  43. package/src/templates/agents/codex/commands/sdd-requirements.md +438 -0
  44. package/src/templates/agents/codex/commands/sdd-steering.md +334 -0
  45. package/src/templates/agents/codex/commands/sdd-tasks.md +582 -0
  46. package/src/templates/agents/codex/commands/sdd-validate.md +710 -0
  47. package/src/templates/agents/cursor/AGENTS.md +138 -0
  48. package/src/templates/agents/cursor/commands/sdd-design.md +673 -0
  49. package/src/templates/agents/cursor/commands/sdd-implement.md +777 -0
  50. package/src/templates/agents/cursor/commands/sdd-requirements.md +438 -0
  51. package/src/templates/agents/cursor/commands/sdd-steering.md +334 -0
  52. package/src/templates/agents/cursor/commands/sdd-tasks.md +582 -0
  53. package/src/templates/agents/cursor/commands/sdd-validate.md +710 -0
  54. package/src/templates/agents/gemini-cli/GEMINI.md +128 -0
  55. package/src/templates/agents/gemini-cli/commands/sdd-design.toml +359 -0
  56. package/src/templates/agents/gemini-cli/commands/sdd-implement.toml +484 -0
  57. package/src/templates/agents/gemini-cli/commands/sdd-requirements.toml +291 -0
  58. package/src/templates/agents/gemini-cli/commands/sdd-steering.toml +209 -0
  59. package/src/templates/agents/gemini-cli/commands/sdd-tasks.toml +441 -0
  60. package/src/templates/agents/gemini-cli/commands/sdd-validate.toml +553 -0
  61. package/src/templates/agents/github-copilot/AGENTS.md +138 -0
  62. package/src/templates/agents/github-copilot/commands/sdd-design.md +673 -0
  63. package/src/templates/agents/github-copilot/commands/sdd-implement.md +777 -0
  64. package/src/templates/agents/github-copilot/commands/sdd-requirements.md +438 -0
  65. package/src/templates/agents/github-copilot/commands/sdd-steering.md +334 -0
  66. package/src/templates/agents/github-copilot/commands/sdd-tasks.md +582 -0
  67. package/src/templates/agents/github-copilot/commands/sdd-validate.md +710 -0
  68. package/src/templates/agents/qwen-code/QWEN.md +128 -0
  69. package/src/templates/agents/qwen-code/commands/sdd-design.md +673 -0
  70. package/src/templates/agents/qwen-code/commands/sdd-implement.md +777 -0
  71. package/src/templates/agents/qwen-code/commands/sdd-requirements.md +438 -0
  72. package/src/templates/agents/qwen-code/commands/sdd-steering.md +334 -0
  73. package/src/templates/agents/qwen-code/commands/sdd-tasks.md +582 -0
  74. package/src/templates/agents/qwen-code/commands/sdd-validate.md +710 -0
  75. package/src/templates/agents/windsurf/AGENTS.md +138 -0
  76. package/src/templates/agents/windsurf/commands/sdd-design.md +673 -0
  77. package/src/templates/agents/windsurf/commands/sdd-implement.md +777 -0
  78. package/src/templates/agents/windsurf/commands/sdd-requirements.md +438 -0
  79. package/src/templates/agents/windsurf/commands/sdd-steering.md +334 -0
  80. package/src/templates/agents/windsurf/commands/sdd-tasks.md +582 -0
  81. package/src/templates/agents/windsurf/commands/sdd-validate.md +710 -0
  82. package/src/templates/shared/constitution/constitution.md +408 -0
  83. package/src/templates/shared/constitution/ears-format.md +613 -0
  84. package/src/templates/shared/constitution/workflow.md +653 -0
  85. package/src/templates/shared/documents/design.md +737 -0
  86. package/src/templates/shared/documents/requirements.md +329 -0
  87. package/src/templates/shared/documents/research.md +494 -0
  88. package/src/templates/shared/documents/tasks.md +781 -0
  89. package/src/templates/shared/steering/product.md +544 -0
  90. package/src/templates/shared/steering/structure.md +405 -0
  91. package/src/templates/shared/steering/tech.md +537 -0
@@ -0,0 +1,544 @@
1
+ # Product Context
2
+
3
+ **Project**: {{PROJECT_NAME}}
4
+ **Last Updated**: {{DATE}}
5
+ **Version**: 1.0
6
+
7
+ ---
8
+
9
+ ## Product Vision
10
+
11
+ **Vision Statement**: {{VISION_STATEMENT}}
12
+
13
+ > [1-2 paragraph description of what this product aims to achieve and why it exists]
14
+
15
+ **Mission**: {{MISSION_STATEMENT}}
16
+
17
+ > [How the product achieves its vision]
18
+
19
+ ---
20
+
21
+ ## Product Overview
22
+
23
+ ### What is {{PROJECT_NAME}}?
24
+
25
+ {{DESCRIPTION}}
26
+
27
+ > [2-3 paragraphs explaining the product, its purpose, and core value proposition]
28
+
29
+ ### Problem Statement
30
+
31
+ **Problem**: {{PROBLEM_STATEMENT}}
32
+
33
+ > [What problem does this product solve? What pain points does it address?]
34
+
35
+ ### Solution
36
+
37
+ **Solution**: {{SOLUTION_STATEMENT}}
38
+
39
+ > [How does this product solve the problem? What makes it unique?]
40
+
41
+ ---
42
+
43
+ ## Target Users
44
+
45
+ ### Primary Users
46
+
47
+ #### User Persona 1: {{PERSONA_1_NAME}}
48
+
49
+ **Demographics**:
50
+ - **Role**: {{ROLE}}
51
+ - **Organization Size**: {{ORG_SIZE}}
52
+ - **Technical Level**: {{TECH_LEVEL}}
53
+
54
+ **Goals**:
55
+ - [Goal 1]
56
+ - [Goal 2]
57
+ - [Goal 3]
58
+
59
+ **Pain Points**:
60
+ - [Pain point 1]
61
+ - [Pain point 2]
62
+ - [Pain point 3]
63
+
64
+ **Use Cases**:
65
+ - [Use case 1]
66
+ - [Use case 2]
67
+ - [Use case 3]
68
+
69
+ ---
70
+
71
+ #### User Persona 2: {{PERSONA_2_NAME}}
72
+
73
+ **Demographics**:
74
+ - **Role**: {{ROLE}}
75
+ - **Organization Size**: {{ORG_SIZE}}
76
+ - **Technical Level**: {{TECH_LEVEL}}
77
+
78
+ **Goals**:
79
+ - [Goal 1]
80
+ - [Goal 2]
81
+
82
+ **Pain Points**:
83
+ - [Pain point 1]
84
+ - [Pain point 2]
85
+
86
+ **Use Cases**:
87
+ - [Use case 1]
88
+ - [Use case 2]
89
+
90
+ ---
91
+
92
+ ### Secondary Users
93
+
94
+ - **{{SECONDARY_USER_1}}**: [Description and role]
95
+ - **{{SECONDARY_USER_2}}**: [Description and role]
96
+
97
+ ---
98
+
99
+ ## Market & Business Context
100
+
101
+ ### Market Opportunity
102
+
103
+ **Market Size**: {{MARKET_SIZE}}
104
+
105
+ **Target Market**: {{TARGET_MARKET}}
106
+
107
+ > [Description of the market opportunity, competitive landscape, and positioning]
108
+
109
+ ### Business Model
110
+
111
+ **Revenue Model**: {{REVENUE_MODEL}}
112
+
113
+ > Examples: SaaS subscription, One-time purchase, Freemium, Usage-based
114
+
115
+ **Pricing Tiers** (if applicable):
116
+ - **Free Tier**: [Features, limitations]
117
+ - **Pro Tier**: ${{PRICE}}/month - [Features]
118
+ - **Enterprise Tier**: Custom pricing - [Features]
119
+
120
+ ### Competitive Landscape
121
+
122
+ | Competitor | Strengths | Weaknesses | Our Differentiation |
123
+ |------------|-----------|------------|---------------------|
124
+ | {{COMPETITOR_1}} | [Strengths] | [Weaknesses] | [How we're different] |
125
+ | {{COMPETITOR_2}} | [Strengths] | [Weaknesses] | [How we're different] |
126
+
127
+ ---
128
+
129
+ ## Core Product Capabilities
130
+
131
+ ### Must-Have Features (MVP)
132
+
133
+ 1. **{{FEATURE_1}}**
134
+ - **Description**: [What it does]
135
+ - **User Value**: [Why users need it]
136
+ - **Priority**: P0 (Critical)
137
+
138
+ 2. **{{FEATURE_2}}**
139
+ - **Description**: [What it does]
140
+ - **User Value**: [Why users need it]
141
+ - **Priority**: P0 (Critical)
142
+
143
+ 3. **{{FEATURE_3}}**
144
+ - **Description**: [What it does]
145
+ - **User Value**: [Why users need it]
146
+ - **Priority**: P0 (Critical)
147
+
148
+ ### High-Priority Features (Post-MVP)
149
+
150
+ 4. **{{FEATURE_4}}**
151
+ - **Description**: [What it does]
152
+ - **User Value**: [Why users need it]
153
+ - **Priority**: P1 (High)
154
+
155
+ 5. **{{FEATURE_5}}**
156
+ - **Description**: [What it does]
157
+ - **User Value**: [Why users need it]
158
+ - **Priority**: P1 (High)
159
+
160
+ ### Future Features (Roadmap)
161
+
162
+ 6. **{{FEATURE_6}}**
163
+ - **Description**: [What it does]
164
+ - **User Value**: [Why users need it]
165
+ - **Priority**: P2 (Medium)
166
+
167
+ 7. **{{FEATURE_7}}**
168
+ - **Description**: [What it does]
169
+ - **User Value**: [Why users need it]
170
+ - **Priority**: P3 (Low)
171
+
172
+ ---
173
+
174
+ ## Product Principles
175
+
176
+ ### Design Principles
177
+
178
+ 1. **{{PRINCIPLE_1}}**
179
+ - [Description of what this means for product decisions]
180
+
181
+ 2. **{{PRINCIPLE_2}}**
182
+ - [Description]
183
+
184
+ 3. **{{PRINCIPLE_3}}**
185
+ - [Description]
186
+
187
+ **Examples**:
188
+ - **Simplicity First**: Favor simple solutions over complex ones
189
+ - **User Empowerment**: Give users control and flexibility
190
+ - **Speed & Performance**: Fast response times (< 200ms)
191
+
192
+ ### User Experience Principles
193
+
194
+ 1. **{{UX_PRINCIPLE_1}}**
195
+ - [How this guides UX decisions]
196
+
197
+ 2. **{{UX_PRINCIPLE_2}}**
198
+ - [How this guides UX decisions]
199
+
200
+ **Examples**:
201
+ - **Progressive Disclosure**: Show advanced features only when needed
202
+ - **Accessibility First**: WCAG 2.1 AA compliance
203
+ - **Mobile-First**: Design for mobile, enhance for desktop
204
+
205
+ ---
206
+
207
+ ## Success Metrics
208
+
209
+ ### Key Performance Indicators (KPIs)
210
+
211
+ #### Business Metrics
212
+
213
+ | Metric | Target | Measurement |
214
+ |--------|--------|-------------|
215
+ | **Monthly Active Users (MAU)** | {{MAU_TARGET}} | [How measured] |
216
+ | **Monthly Recurring Revenue (MRR)** | ${{MRR_TARGET}} | [How measured] |
217
+ | **Customer Acquisition Cost (CAC)** | ${{CAC_TARGET}} | [How measured] |
218
+ | **Customer Lifetime Value (LTV)** | ${{LTV_TARGET}} | [How measured] |
219
+ | **Churn Rate** | < {{CHURN_RATE}}% | [How measured] |
220
+
221
+ #### Product Metrics
222
+
223
+ | Metric | Target | Measurement |
224
+ |--------|--------|-------------|
225
+ | **Daily Active Users (DAU)** | {{DAU_TARGET}} | [How measured] |
226
+ | **Feature Adoption Rate** | > {{ADOPTION_RATE}}% | [How measured] |
227
+ | **User Retention (Day 7)** | > {{RETENTION_RATE}}% | [How measured] |
228
+ | **Net Promoter Score (NPS)** | > {{NPS_TARGET}} | [How measured] |
229
+
230
+ #### Technical Metrics
231
+
232
+ | Metric | Target | Measurement |
233
+ |--------|--------|-------------|
234
+ | **API Response Time (p95)** | < 200ms | Monitoring dashboard |
235
+ | **Uptime** | 99.9% | Status page |
236
+ | **Error Rate** | < 0.1% | Error tracking (Sentry) |
237
+ | **Page Load Time** | < 2s | Web vitals |
238
+
239
+ ---
240
+
241
+ ## Product Roadmap
242
+
243
+ ### Phase 1: MVP (Months 1-3)
244
+
245
+ **Goal**: Launch minimum viable product
246
+
247
+ **Features**:
248
+ - [Feature 1]
249
+ - [Feature 2]
250
+ - [Feature 3]
251
+
252
+ **Success Criteria**:
253
+ - [Criterion 1]
254
+ - [Criterion 2]
255
+
256
+ ---
257
+
258
+ ### Phase 2: Growth (Months 4-6)
259
+
260
+ **Goal**: Achieve product-market fit
261
+
262
+ **Features**:
263
+ - [Feature 4]
264
+ - [Feature 5]
265
+ - [Feature 6]
266
+
267
+ **Success Criteria**:
268
+ - [Criterion 1]
269
+ - [Criterion 2]
270
+
271
+ ---
272
+
273
+ ### Phase 3: Scale (Months 7-12)
274
+
275
+ **Goal**: Scale to {{USER_TARGET}} users
276
+
277
+ **Features**:
278
+ - [Feature 7]
279
+ - [Feature 8]
280
+ - [Feature 9]
281
+
282
+ **Success Criteria**:
283
+ - [Criterion 1]
284
+ - [Criterion 2]
285
+
286
+ ---
287
+
288
+ ## User Workflows
289
+
290
+ ### Primary Workflow 1: {{WORKFLOW_1_NAME}}
291
+
292
+ **User Goal**: {{USER_GOAL}}
293
+
294
+ **Steps**:
295
+ 1. User [action 1]
296
+ 2. System [response 1]
297
+ 3. User [action 2]
298
+ 4. System [response 2]
299
+ 5. User achieves [goal]
300
+
301
+ **Success Criteria**:
302
+ - User completes workflow in < {{TIME}} minutes
303
+ - Success rate > {{SUCCESS_RATE}}%
304
+
305
+ ---
306
+
307
+ ### Primary Workflow 2: {{WORKFLOW_2_NAME}}
308
+
309
+ **User Goal**: {{USER_GOAL}}
310
+
311
+ **Steps**:
312
+ 1. [Step 1]
313
+ 2. [Step 2]
314
+ 3. [Step 3]
315
+
316
+ **Success Criteria**:
317
+ - [Criterion 1]
318
+ - [Criterion 2]
319
+
320
+ ---
321
+
322
+ ## Business Domain
323
+
324
+ ### Domain Concepts
325
+
326
+ Key concepts and terminology used in this domain:
327
+
328
+ 1. **{{CONCEPT_1}}**: [Definition and importance]
329
+ 2. **{{CONCEPT_2}}**: [Definition and importance]
330
+ 3. **{{CONCEPT_3}}**: [Definition and importance]
331
+
332
+ **Example for SaaS Authentication**:
333
+ - **Identity Provider (IdP)**: Service that authenticates users
334
+ - **Single Sign-On (SSO)**: One login for multiple applications
335
+ - **Multi-Factor Authentication (MFA)**: Additional verification step
336
+
337
+ ### Business Rules
338
+
339
+ 1. **{{RULE_1}}**
340
+ - [Description of business rule]
341
+ - **Example**: [Concrete example]
342
+
343
+ 2. **{{RULE_2}}**
344
+ - [Description]
345
+ - **Example**: [Example]
346
+
347
+ **Example for E-commerce**:
348
+ - **Inventory Reservation**: Reserved items held for 10 minutes during checkout
349
+ - **Refund Window**: Refunds allowed within 30 days of purchase
350
+
351
+ ---
352
+
353
+ ## Constraints & Requirements
354
+
355
+ ### Business Constraints
356
+
357
+ - **Budget**: ${{BUDGET}}
358
+ - **Timeline**: {{TIMELINE}}
359
+ - **Team Size**: {{TEAM_SIZE}} engineers
360
+ - **Launch Date**: {{LAUNCH_DATE}}
361
+
362
+ ### Compliance Requirements
363
+
364
+ - **{{COMPLIANCE_1}}**: [Description, e.g., GDPR, SOC 2, HIPAA]
365
+ - **{{COMPLIANCE_2}}**: [Description]
366
+ - **Data Residency**: [Requirements, e.g., EU data stays in EU]
367
+
368
+ ### Non-Functional Requirements
369
+
370
+ - **Performance**: API response < 200ms (95th percentile)
371
+ - **Availability**: 99.9% uptime SLA
372
+ - **Scalability**: Support {{CONCURRENT_USERS}} concurrent users
373
+ - **Security**: OWASP Top 10 compliance
374
+ - **Accessibility**: WCAG 2.1 AA compliance
375
+
376
+ ---
377
+
378
+ ## Stakeholders
379
+
380
+ ### Internal Stakeholders
381
+
382
+ | Role | Name | Responsibilities |
383
+ |------|------|------------------|
384
+ | **Product Owner** | {{PO_NAME}} | Vision, roadmap, priorities |
385
+ | **Tech Lead** | {{TECH_LEAD_NAME}} | Architecture, technical decisions |
386
+ | **Engineering Manager** | {{EM_NAME}} | Team management, delivery |
387
+ | **QA Lead** | {{QA_LEAD_NAME}} | Quality assurance, testing |
388
+ | **Design Lead** | {{DESIGN_LEAD_NAME}} | UX/UI design |
389
+
390
+ ### External Stakeholders
391
+
392
+ | Role | Name | Responsibilities |
393
+ |------|------|------------------|
394
+ | **Customer Advisory Board** | [Members] | Product feedback |
395
+ | **Investors** | [Names] | Funding, strategic guidance |
396
+ | **Partners** | [Companies] | Integration, co-marketing |
397
+
398
+ ---
399
+
400
+ ## Go-to-Market Strategy
401
+
402
+ ### Launch Strategy
403
+
404
+ **Target Launch Date**: {{LAUNCH_DATE}}
405
+
406
+ **Launch Phases**:
407
+ 1. **Private Beta** ({{START_DATE}} - {{END_DATE}})
408
+ - Invite-only, 50 beta users
409
+ - Focus: Gather feedback, fix critical bugs
410
+
411
+ 2. **Public Beta** ({{START_DATE}} - {{END_DATE}})
412
+ - Open signup
413
+ - Focus: Validate product-market fit
414
+
415
+ 3. **General Availability** ({{LAUNCH_DATE}})
416
+ - Full public launch
417
+ - Focus: Acquisition and growth
418
+
419
+ ### Marketing Channels
420
+
421
+ - **{{CHANNEL_1}}**: [Strategy, e.g., Content marketing, SEO]
422
+ - **{{CHANNEL_2}}**: [Strategy, e.g., Social media, Twitter/LinkedIn]
423
+ - **{{CHANNEL_3}}**: [Strategy, e.g., Paid ads, Google/Facebook]
424
+ - **{{CHANNEL_4}}**: [Strategy, e.g., Partnerships, integrations]
425
+
426
+ ---
427
+
428
+ ## Risk Assessment
429
+
430
+ ### Product Risks
431
+
432
+ | Risk | Probability | Impact | Mitigation |
433
+ |------|-------------|--------|------------|
434
+ | {{RISK_1}} | High/Medium/Low | High/Medium/Low | [Mitigation strategy] |
435
+ | {{RISK_2}} | High/Medium/Low | High/Medium/Low | [Mitigation strategy] |
436
+
437
+ **Example Risks**:
438
+ - **Low adoption**: Users don't understand value → Clear onboarding, demos
439
+ - **Performance issues**: System slow at scale → Load testing, optimization
440
+ - **Security breach**: Data compromised → Security audit, penetration testing
441
+
442
+ ---
443
+
444
+ ## Customer Support
445
+
446
+ ### Support Channels
447
+
448
+ - **Email**: support@{{COMPANY}}.com
449
+ - **Chat**: In-app live chat (business hours)
450
+ - **Documentation**: docs.{{COMPANY}}.com
451
+ - **Community**: Forum/Discord/Slack
452
+
453
+ ### Support SLA
454
+
455
+ | Tier | Response Time | Resolution Time |
456
+ |------|---------------|-----------------|
457
+ | **Critical (P0)** | < 1 hour | < 4 hours |
458
+ | **High (P1)** | < 4 hours | < 24 hours |
459
+ | **Medium (P2)** | < 24 hours | < 3 days |
460
+ | **Low (P3)** | < 48 hours | Best effort |
461
+
462
+ ---
463
+
464
+ ## Product Analytics
465
+
466
+ ### Analytics Tools
467
+
468
+ - **{{ANALYTICS_TOOL_1}}**: [Purpose, e.g., Google Analytics, Mixpanel]
469
+ - **{{ANALYTICS_TOOL_2}}**: [Purpose, e.g., Amplitude, Heap]
470
+
471
+ ### Events to Track
472
+
473
+ | Event | Description | Purpose |
474
+ |-------|-------------|---------|
475
+ | `user_signup` | New user registration | Track acquisition |
476
+ | `feature_used` | User uses core feature | Track engagement |
477
+ | `payment_completed` | User completes payment | Track conversion |
478
+ | `error_occurred` | User encounters error | Track reliability |
479
+
480
+ ---
481
+
482
+ ## Localization & Internationalization
483
+
484
+ ### Supported Languages
485
+
486
+ - **Primary**: English (en-US)
487
+ - **Secondary**: [Languages, e.g., Japanese (ja-JP), Spanish (es-ES)]
488
+
489
+ ### Localization Strategy
490
+
491
+ - **UI Strings**: i18n framework (next-intl, react-i18next)
492
+ - **Date/Time**: Locale-aware formatting
493
+ - **Currency**: Multi-currency support
494
+ - **Right-to-Left (RTL)**: Support for Arabic, Hebrew (if needed)
495
+
496
+ ---
497
+
498
+ ## Data & Privacy
499
+
500
+ ### Data Collection
501
+
502
+ **What data we collect**:
503
+ - User account information (email, name)
504
+ - Usage analytics (anonymized)
505
+ - Error logs (for debugging)
506
+
507
+ **What data we DON'T collect**:
508
+ - [Sensitive data we avoid, e.g., passwords (only hashed), payment details (tokenized)]
509
+
510
+ ### Privacy Policy
511
+
512
+ - **GDPR Compliance**: Right to access, delete, export data
513
+ - **Data Retention**: [Retention period, e.g., 90 days for logs]
514
+ - **Third-Party Sharing**: [Who we share data with, why]
515
+
516
+ ---
517
+
518
+ ## Integrations
519
+
520
+ ### Existing Integrations
521
+
522
+ | Integration | Purpose | Priority |
523
+ |-------------|---------|----------|
524
+ | {{INTEGRATION_1}} | [Purpose] | P0 |
525
+ | {{INTEGRATION_2}} | [Purpose] | P1 |
526
+
527
+ ### Planned Integrations
528
+
529
+ | Integration | Purpose | Timeline |
530
+ |-------------|---------|----------|
531
+ | {{INTEGRATION_3}} | [Purpose] | Q2 2025 |
532
+ | {{INTEGRATION_4}} | [Purpose] | Q3 2025 |
533
+
534
+ ---
535
+
536
+ ## Changelog
537
+
538
+ ### Version 1.1 (Planned)
539
+ - [Future product updates]
540
+
541
+ ---
542
+
543
+ **Last Updated**: {{DATE}}
544
+ **Maintained By**: {{MAINTAINER}}