telo3-ai 5.0.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.
@@ -0,0 +1,368 @@
1
+ # Project Memory
2
+
3
+ > **Purpose:** Track CURRENT STATE — recent work, important decisions, continuity information, and project-specific knowledge.
4
+ > **Last Updated:** [Date]
5
+
6
+ ---
7
+
8
+ ## Current State
9
+
10
+ ### Project Status
11
+ **Overall status:** [Not Started / Active Development / MVP Complete / Production / Maintenance]
12
+
13
+ **Current phase:** [e.g., Phase 2 — Core Features]
14
+
15
+ **Active work:**
16
+ - [What is currently being worked on]
17
+ - [Current focus areas]
18
+
19
+ **Last deployed:** [Date or N/A]
20
+
21
+ ---
22
+
23
+ ## Recently Completed Work
24
+
25
+ ### [Date Range: e.g., Last 2 Weeks]
26
+
27
+ - **[Date]:** [Completed work item]
28
+ - **Details:** [Brief description of what was done]
29
+ - **Impact:** [How this affects the product]
30
+ - **Files changed:** [Key files if relevant]
31
+
32
+ - **[Date]:** [Completed work item]
33
+
34
+ ---
35
+
36
+ ## Important Decisions
37
+
38
+ [Decisions that should not be reversed without careful consideration]
39
+
40
+ ### [Date]: [Decision Title]
41
+ **Decision:** [What was decided]
42
+ **Rationale:** [Why this decision was made]
43
+ **Context:** [What was the situation that led to this decision]
44
+ **Alternatives considered:** [What else was considered]
45
+ **Trade-offs:** [What are the downsides]
46
+ **Status:** [Active / Under Review / Superseded]
47
+ **DO NOT reverse without:** [Criteria for reconsidering]
48
+
49
+ ---
50
+
51
+ ## Architectural Decisions
52
+
53
+ ### Current Architecture Choices
54
+
55
+ - **[Technology/Pattern choice]:** [Why chosen]
56
+ - **Reason:** [Detailed rationale]
57
+ - **Alternatives:** [What was not chosen and why]
58
+
59
+ ---
60
+
61
+ ## Known Issues & Bugs
62
+
63
+ ### Critical
64
+ - **[Issue description]**
65
+ - **Impact:** [How this affects users]
66
+ - **Workaround:** [Temporary solution if available]
67
+ - **Plan:** [How/when will this be fixed]
68
+
69
+ ### Non-Critical
70
+ - **[Issue description]**
71
+ - **Impact:**
72
+ - **Priority:** [When this might be addressed]
73
+
74
+ ---
75
+
76
+ ## Known Limitations
77
+
78
+ [Documented limitations of the current implementation]
79
+
80
+ - **[Limitation 1]:** [Description]
81
+ - **Reason:** [Why this limitation exists]
82
+ - **Future plan:** [If/when this might be addressed]
83
+
84
+ - **[Limitation 2]:** [Description]
85
+
86
+ ---
87
+
88
+ ## Technical Debt
89
+
90
+ [Technical debt that has been explicitly accepted, with context]
91
+
92
+ - **[Debt item]:**
93
+ - **Introduced:** [When and why was this shortcut taken]
94
+ - **Impact:** [What is the cost of this debt]
95
+ - **Plan:** [When/how should this be addressed]
96
+
97
+ ---
98
+
99
+ ## Temporary Workarounds
100
+
101
+ [Temporary solutions that should be revisited]
102
+
103
+ - **[Workaround description]:**
104
+ - **Location:** [Where in code]
105
+ - **Reason:** [Why was this necessary]
106
+ - **Replace with:** [What is the proper solution]
107
+ - **Timeline:** [When should this be addressed]
108
+
109
+ ---
110
+
111
+ ## Important Discoveries
112
+
113
+ [Findings, insights, or lessons learned during development]
114
+
115
+ ### Technical Discoveries
116
+ - **[Discovery]:** [What was learned]
117
+ - **Implication:** [How this affects the project]
118
+
119
+ ### User Insights
120
+ - **[Insight]:** [What was learned about users]
121
+ - **Action:** [How this influences design/development]
122
+
123
+ ---
124
+
125
+ ## Security Considerations
126
+
127
+ [Security-related information that must remain known]
128
+
129
+ ### Implemented Security Controls
130
+ - [Control 1: e.g., "Rate limiting on auth endpoints"]
131
+ - [Control 2]
132
+
133
+ ### Security Decisions
134
+ - **[Decision]:** [e.g., "Using bcrypt for password hashing"]
135
+ - **Reason:** [Why this approach]
136
+
137
+ ### Security TODOs
138
+ - [ ] [Security improvement needed]
139
+
140
+ **IMPORTANT:** Never store secrets, API keys, or credentials in this document.
141
+
142
+ ---
143
+
144
+ ## Privacy Considerations
145
+
146
+ [Privacy-sensitive functionality and decisions]
147
+
148
+ ### Data Collection
149
+ - **Personal data collected:** [Types of data]
150
+ - **Purpose:** [Why each type is collected]
151
+ - **Retention:** [How long data is kept]
152
+
153
+ ### Third-Party Services
154
+ - **[Service name]:** [What data is shared]
155
+ - **Purpose:** [Why this service is used]
156
+ - **Privacy policy:** [Link]
157
+
158
+ ### Privacy Decisions
159
+ - **[Decision]:** [e.g., "Self-hosting fonts instead of Google Fonts"]
160
+ - **Reason:** [Why this was chosen]
161
+
162
+ ---
163
+
164
+ ## Legal & Compliance Considerations
165
+
166
+ > **Note:** This section documents engineering decisions related to legal/compliance considerations, not legal advice.
167
+
168
+ ### Applicable Considerations
169
+ - **[Area: e.g., "Age restrictions"]:** [Status and implementation]
170
+ - **[Area: e.g., "Email unsubscribe"]:** [Status and implementation]
171
+
172
+ ### Compliance TODOs
173
+ - [ ] [Compliance-related task]
174
+
175
+ **IMPORTANT:** Verify current legal requirements with qualified counsel before claiming compliance.
176
+
177
+ ---
178
+
179
+ ## Pending Questions
180
+
181
+ [Open questions that need to be resolved]
182
+
183
+ - [ ] **[Question]:** [What needs to be clarified]
184
+ - **Impact:** [Why this matters]
185
+ - **Owner:** [Who should answer this]
186
+
187
+ ---
188
+
189
+ ## Recent Architectural Changes
190
+
191
+ [Significant changes to architecture or patterns]
192
+
193
+ ### [Date]: [Change description]
194
+ **What changed:** [Description]
195
+ **Why:** [Rationale]
196
+ **Migration status:** [Complete / In Progress / Not Started]
197
+ **Follow-up needed:** [Any remaining work]
198
+
199
+ ---
200
+
201
+ ## Project-Specific Preferences
202
+
203
+ [Preferences established for this project that differ from defaults or are important to remember]
204
+
205
+ ### Code Preferences
206
+ - **[Preference]:** [e.g., "Prefer server components over client components in Next.js"]
207
+ - **Reason:** [Why this preference exists]
208
+
209
+ ### Design Preferences
210
+ - **[Preference]:** [e.g., "Avoid shadows on buttons"]
211
+ - **Reason:** [Why this is preferred]
212
+
213
+ ### Process Preferences
214
+ - **[Preference]:** [e.g., "Always include tests with new features"]
215
+ - **Reason:** [Why this is important]
216
+
217
+ ---
218
+
219
+ ## Stakeholder Context
220
+
221
+ [Important context about stakeholders, if applicable]
222
+
223
+ - **Primary stakeholder:** [Name/Role]
224
+ - **Priorities:** [What matters most to them]
225
+ - **Communication preference:** [How they prefer updates]
226
+
227
+ ---
228
+
229
+ ## Environment-Specific Notes
230
+
231
+ ### Development
232
+ - [Important information about dev environment]
233
+
234
+ ### Staging
235
+ - [Important information about staging environment]
236
+
237
+ ### Production
238
+ - [Important information about production environment]
239
+
240
+ ---
241
+
242
+ ## Integration-Specific Notes
243
+
244
+ [Notes about external service integrations]
245
+
246
+ ### [Service Name]
247
+ - **Account:** [Account information (not credentials)]
248
+ - **Configuration:** [Important configuration details]
249
+ - **Gotchas:** [Things to watch out for]
250
+ - **Docs:** [Link to service documentation]
251
+
252
+ ---
253
+
254
+ ## Performance Notes
255
+
256
+ [Performance-related observations and decisions]
257
+
258
+ - **[Observation]:** [Performance finding]
259
+ - **Impact:** [Effect on user experience]
260
+ - **Action taken:** [What was done about it]
261
+
262
+ ---
263
+
264
+ ## Onboarding Notes
265
+
266
+ [Information helpful for new developers joining the project]
267
+
268
+ ### Getting Started
269
+ - [Key information for new team members]
270
+
271
+ ### Common Pitfalls
272
+ - **[Pitfall]:** [Common mistake]
273
+ - **Solution:** [How to avoid it]
274
+
275
+ ### Useful Commands
276
+ ```bash
277
+ # [Command description]
278
+ npm run [command]
279
+ ```
280
+
281
+ ---
282
+
283
+ ## Team Agreements
284
+
285
+ [Agreements the team has made about how to work]
286
+
287
+ - **[Agreement]:** [e.g., "Always update tasks.md after completing work"]
288
+ - **[Agreement]:** [e.g., "Run tests before opening PR"]
289
+
290
+ ---
291
+
292
+ ## Deferred Decisions
293
+
294
+ [Decisions that have been explicitly deferred]
295
+
296
+ - **[Decision topic]:**
297
+ - **Why deferred:** [Reason for waiting]
298
+ - **Revisit when:** [Criteria or timeline]
299
+
300
+ ---
301
+
302
+ ## Migration Notes
303
+
304
+ [If migrating from another system or undergoing significant changes]
305
+
306
+ ### Migration Status
307
+ - **From:** [Old system]
308
+ - **To:** [New system]
309
+ - **Progress:** [X% complete or status]
310
+ - **Remaining work:** [What's left]
311
+
312
+ ---
313
+
314
+ ## Monitoring & Observability
315
+
316
+ [Important information about monitoring and debugging]
317
+
318
+ ### Key Metrics
319
+ - **[Metric]:** [Where to find it, what it means]
320
+
321
+ ### Debugging Tips
322
+ - **[Tip]:** [Useful debugging information]
323
+
324
+ ---
325
+
326
+ ## Seasonal / Time-Based Notes
327
+
328
+ [Information that applies at specific times]
329
+
330
+ - **[Period]:** [Special considerations]
331
+
332
+ ---
333
+
334
+ ## Important Don'ts
335
+
336
+ [Explicit prohibitions or things to avoid based on past experience]
337
+
338
+ - ❌ **[Don't do this]:** [Why not]
339
+ - ❌ **[Don't do this]:** [Why not]
340
+
341
+ ---
342
+
343
+ ## Context for AI Agents
344
+
345
+ [Specific guidance for AI coding assistants working on this project]
346
+
347
+ ### Preferred Patterns
348
+ - [Pattern AI should follow]
349
+
350
+ ### Avoid
351
+ - [Pattern AI should avoid]
352
+
353
+ ### Always Check
354
+ - [Files AI should always reference before making changes]
355
+
356
+ ---
357
+
358
+ ## Notes
359
+
360
+ [Miscellaneous important information that doesn't fit elsewhere]
361
+
362
+ ---
363
+
364
+ ## Document History
365
+
366
+ | Date | Author | Changes |
367
+ |------|--------|---------|
368
+ | [Date] | [Name] | Initial version |
@@ -0,0 +1,320 @@
1
+ # Product Requirements Document (PRD)
2
+
3
+ > **Purpose:** Define WHAT the product is and WHY it exists.
4
+ > **Last Updated:** [Date]
5
+
6
+ ---
7
+
8
+ ## Project Overview
9
+
10
+ ### Project Name
11
+ [Product name]
12
+
13
+ ### Product Summary
14
+ [2-3 sentence description of what this product is and what it does]
15
+
16
+ ### Vision
17
+ [What is the long-term vision? What change do you want to create? What problem are you solving at scale?]
18
+
19
+ ---
20
+
21
+ ## Problem Statement
22
+
23
+ ### The Problem
24
+ [Describe the problem that exists today. Who experiences it? How does it affect them?]
25
+
26
+ ### Current Alternatives
27
+ [What do people use today? Why are current solutions insufficient?]
28
+
29
+ ### Opportunity
30
+ [Why is now the right time to solve this problem? What has changed?]
31
+
32
+ ---
33
+
34
+ ## Target Users
35
+
36
+ ### Primary Users
37
+ [Who is this product for? Be specific about demographics, roles, needs, behaviors.]
38
+
39
+ ### User Segments
40
+ | Segment | Description | Key Needs | Priority |
41
+ |---------|-------------|-----------|----------|
42
+ | [Segment name] | [Who they are] | [What they need] | High/Medium/Low |
43
+
44
+ ### User Personas (Optional)
45
+ [If helpful, describe 1-2 representative personas with goals, pain points, and context]
46
+
47
+ ---
48
+
49
+ ## Core Use Cases
50
+
51
+ ### Primary Use Cases
52
+ 1. **[Use case name]**
53
+ - **User goal:** [What is the user trying to accomplish?]
54
+ - **Current flow:** [How do they do it today?]
55
+ - **Proposed flow:** [How will they do it with this product?]
56
+ - **Value:** [What improvement does this provide?]
57
+
58
+ 2. **[Use case name]**
59
+ - **User goal:**
60
+ - **Current flow:**
61
+ - **Proposed flow:**
62
+ - **Value:**
63
+
64
+ ### Secondary Use Cases
65
+ [Less critical use cases that are supported but not central to the product]
66
+
67
+ ---
68
+
69
+ ## Goals
70
+
71
+ ### Business Goals
72
+ - [What business outcomes are we trying to achieve?]
73
+ - [How will we measure success from a business perspective?]
74
+
75
+ ### User Goals
76
+ - [What outcomes are we trying to create for users?]
77
+ - [How will we measure user success?]
78
+
79
+ ### Technical Goals
80
+ - [Any technical objectives? Performance targets? Scalability goals?]
81
+
82
+ ---
83
+
84
+ ## Non-Goals
85
+
86
+ [What is explicitly OUT of scope? What will we NOT do? This prevents scope creep and clarifies boundaries.]
87
+
88
+ - [Non-goal 1]
89
+ - [Non-goal 2]
90
+
91
+ ---
92
+
93
+ ## Functional Requirements
94
+
95
+ ### Core Features (MVP)
96
+
97
+ #### [Feature 1 Name]
98
+ - **Description:** [What does this feature do?]
99
+ - **User value:** [Why is this important?]
100
+ - **Acceptance criteria:**
101
+ - [ ] [Specific, testable criterion]
102
+ - [ ] [Specific, testable criterion]
103
+ - **Priority:** Must-have / Should-have / Nice-to-have
104
+
105
+ #### [Feature 2 Name]
106
+ - **Description:**
107
+ - **User value:**
108
+ - **Acceptance criteria:**
109
+ - [ ]
110
+ - **Priority:**
111
+
112
+ ### Future Features
113
+
114
+ [Features that are important but not part of MVP. Include rough priority and rationale.]
115
+
116
+ - **[Feature name]:** [Description] — Priority: [High/Medium/Low]
117
+
118
+ ---
119
+
120
+ ## User Experience Requirements
121
+
122
+ ### Key User Flows
123
+ [Describe critical user journeys from entry to goal completion]
124
+
125
+ 1. **[Flow name]:** [Entry point] → [Steps] → [Outcome]
126
+
127
+ ### Accessibility Requirements
128
+ - [ ] WCAG 2.1 Level AA compliance
129
+ - [ ] Keyboard navigation support
130
+ - [ ] Screen reader compatibility
131
+ - [ ] [Other specific requirements]
132
+
133
+ ### Responsive Behavior
134
+ - [ ] Mobile-first design
135
+ - [ ] Tablet optimization
136
+ - [ ] Desktop experience
137
+ - [ ] [Specific breakpoint requirements]
138
+
139
+ ### Performance Requirements
140
+ - [ ] Page load < [X] seconds
141
+ - [ ] Time to interactive < [X] seconds
142
+ - [ ] [Other specific performance targets]
143
+
144
+ ---
145
+
146
+ ## Technical Requirements
147
+
148
+ ### Platform
149
+ - [ ] Web application
150
+ - [ ] Mobile (iOS/Android)
151
+ - [ ] Desktop
152
+ - [ ] API/Backend service
153
+ - [ ] [Other]
154
+
155
+ ### Browser/Device Support
156
+ - **Browsers:** [Specify minimum versions]
157
+ - **Devices:** [Specify device support requirements]
158
+
159
+ ### Data Requirements
160
+ - **Data sources:** [Where does data come from?]
161
+ - **Data storage:** [What needs to be persisted?]
162
+ - **Data retention:** [How long is data kept?]
163
+ - **Data privacy:** [What are privacy requirements?]
164
+
165
+ ### Integration Requirements
166
+ [External services, APIs, or systems that must be integrated]
167
+
168
+ - **[Service name]:** [Purpose] — [Criticality]
169
+
170
+ ---
171
+
172
+ ## Security & Privacy Requirements
173
+
174
+ ### Authentication
175
+ - [ ] User registration/login required
176
+ - [ ] Social authentication (Google, GitHub, etc.)
177
+ - [ ] SSO (enterprise)
178
+ - [ ] [Other]
179
+
180
+ ### Authorization
181
+ - [ ] Role-based access control
182
+ - [ ] Permission levels: [Specify]
183
+ - [ ] [Other]
184
+
185
+ ### Privacy
186
+ - [ ] Personal data collected: [List types]
187
+ - [ ] Third-party data sharing: [List services]
188
+ - [ ] User consent required for: [List]
189
+ - [ ] Data deletion supported: [Yes/No]
190
+ - [ ] Cookie usage: [Essential/Analytics/Marketing]
191
+
192
+ ### Compliance Considerations
193
+ [Mark as applicable and note jurisdiction when relevant]
194
+
195
+ - [ ] Children's privacy (e.g., COPPA for U.S.) — [Details]
196
+ - [ ] Marketing email (e.g., CAN-SPAM, GDPR) — [Details]
197
+ - [ ] Subscriptions/auto-renewal — [Details]
198
+ - [ ] User-generated content / DMCA — [Details]
199
+ - [ ] [Other applicable regulations] — [Details]
200
+
201
+ > **Note:** This is a decision-support tool. Verify applicable legal requirements with qualified counsel before claiming compliance.
202
+
203
+ ---
204
+
205
+ ## Constraints
206
+
207
+ ### Technical Constraints
208
+ [Limitations imposed by existing systems, technology choices, or infrastructure]
209
+
210
+ - [Constraint 1]
211
+
212
+ ### Business Constraints
213
+ [Budget, timeline, resource, or strategic limitations]
214
+
215
+ - [Constraint 1]
216
+
217
+ ### Regulatory Constraints
218
+ [Legal or compliance requirements that limit design or implementation]
219
+
220
+ - [Constraint 1]
221
+
222
+ ---
223
+
224
+ ## Dependencies
225
+
226
+ ### Internal Dependencies
227
+ [Other projects, teams, or systems this project depends on]
228
+
229
+ - **[Dependency name]:** [Description] — [Status]
230
+
231
+ ### External Dependencies
232
+ [Third-party services, vendors, or external factors]
233
+
234
+ - **[Dependency name]:** [Description] — [Risk level]
235
+
236
+ ---
237
+
238
+ ## Success Criteria
239
+
240
+ ### Launch Criteria
241
+ [What must be true before this product can launch?]
242
+
243
+ - [ ] [Criterion 1]
244
+ - [ ] [Criterion 2]
245
+
246
+ ### Success Metrics
247
+ [How will we measure whether this product is successful?]
248
+
249
+ | Metric | Target | Timeframe | Measurement Method |
250
+ |--------|--------|-----------|-------------------|
251
+ | [Metric name] | [Target value] | [When] | [How measured] |
252
+
253
+ ---
254
+
255
+ ## Timeline & Milestones
256
+
257
+ ### MVP Milestones
258
+ | Milestone | Target Date | Status |
259
+ |-----------|-------------|--------|
260
+ | [Milestone 1] | [Date] | Not Started / In Progress / Complete |
261
+
262
+ ### Future Phases
263
+ [Post-MVP roadmap at a high level]
264
+
265
+ - **Phase 2:** [Description] — Target: [Timeframe]
266
+ - **Phase 3:** [Description] — Target: [Timeframe]
267
+
268
+ ---
269
+
270
+ ## Product Decisions
271
+
272
+ [Document important product decisions here. Include the decision, rationale, date, and who decided.]
273
+
274
+ ### [Decision Date]: [Decision Title]
275
+ **Decision:** [What was decided?]
276
+ **Rationale:** [Why was this decided?]
277
+ **Alternatives considered:** [What else was considered?]
278
+ **Trade-offs:** [What are the downsides of this choice?]
279
+
280
+ ---
281
+
282
+ ## Current Product Status
283
+
284
+ **Current State:** [Not Started / In Development / MVP Complete / Active / Maintenance]
285
+
286
+ **Implemented Features:**
287
+ - [Feature 1] — [Status]
288
+ - [Feature 2] — [Status]
289
+
290
+ **Known Limitations:**
291
+ - [Limitation 1]
292
+
293
+ **Pending Decisions:**
294
+ - [Open question 1]
295
+
296
+ ---
297
+
298
+ ## Open Questions
299
+
300
+ [Questions that need to be answered before implementation or launch]
301
+
302
+ - [ ] [Question 1]
303
+ - [ ] [Question 2]
304
+
305
+ ---
306
+
307
+ ## References
308
+
309
+ - [Link to user research]
310
+ - [Link to competitive analysis]
311
+ - [Link to design mockups]
312
+ - [Link to technical proposals]
313
+
314
+ ---
315
+
316
+ ## Document History
317
+
318
+ | Date | Author | Changes |
319
+ |------|--------|---------|
320
+ | [Date] | [Name] | Initial version |