@techierathore/techieflow 1.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.
Files changed (151) hide show
  1. package/.claude/commands/TechieFlow/agents/analyst.md +97 -0
  2. package/.claude/commands/TechieFlow/agents/architect.md +84 -0
  3. package/.claude/commands/TechieFlow/agents/flow-master.md +217 -0
  4. package/.claude/commands/TechieFlow/agents/verifier.md +72 -0
  5. package/.claude/commands/TechieFlow/tasks/_metrics-emit-gate.md +138 -0
  6. package/.claude/commands/TechieFlow/tasks/_smoke-test-policy.md +98 -0
  7. package/.claude/commands/TechieFlow/tasks/_status-update-gate.md +78 -0
  8. package/.claude/commands/TechieFlow/tasks/_yolo-mode.md +77 -0
  9. package/.claude/commands/TechieFlow/tasks/advanced-elicitation.md +117 -0
  10. package/.claude/commands/TechieFlow/tasks/amend-docs.md +149 -0
  11. package/.claude/commands/TechieFlow/tasks/author-brd.md +79 -0
  12. package/.claude/commands/TechieFlow/tasks/build-phase.md +231 -0
  13. package/.claude/commands/TechieFlow/tasks/create-deep-research-prompt.md +278 -0
  14. package/.claude/commands/TechieFlow/tasks/create-doc.md +101 -0
  15. package/.claude/commands/TechieFlow/tasks/day1-brownfield.md +507 -0
  16. package/.claude/commands/TechieFlow/tasks/day1-greenfield.md +224 -0
  17. package/.claude/commands/TechieFlow/tasks/devguide.md +224 -0
  18. package/.claude/commands/TechieFlow/tasks/document-project.md +343 -0
  19. package/.claude/commands/TechieFlow/tasks/execute-checklist.md +86 -0
  20. package/.claude/commands/TechieFlow/tasks/facilitate-brainstorming-session.md +136 -0
  21. package/.claude/commands/TechieFlow/tasks/fix-issues.md +134 -0
  22. package/.claude/commands/TechieFlow/tasks/generate-html.md +115 -0
  23. package/.claude/commands/TechieFlow/tasks/handoff-phase.md +126 -0
  24. package/.claude/commands/TechieFlow/tasks/index-docs.md +173 -0
  25. package/.claude/commands/TechieFlow/tasks/kb-mode-interaction.md +75 -0
  26. package/.claude/commands/TechieFlow/tasks/log-miss.md +160 -0
  27. package/.claude/commands/TechieFlow/tasks/metrics-report.md +143 -0
  28. package/.claude/commands/TechieFlow/tasks/mockups.md +122 -0
  29. package/.claude/commands/TechieFlow/tasks/productguide.md +105 -0
  30. package/.claude/commands/TechieFlow/tasks/refresh-status.md +135 -0
  31. package/.claude/commands/TechieFlow/tasks/render-workflow-docs.md +117 -0
  32. package/.claude/commands/TechieFlow/tasks/shard-doc.md +185 -0
  33. package/.claude/commands/TechieFlow/tasks/split-brd.md +131 -0
  34. package/.claude/commands/TechieFlow/tasks/triage-issues.md +157 -0
  35. package/.claude/commands/TechieFlow/tasks/verify-phase.md +579 -0
  36. package/.claude/commands/generate-html.md +124 -0
  37. package/.codex/config.toml +46 -0
  38. package/.codex/hooks.json +63 -0
  39. package/.codex/rules/techieflow.rules +8 -0
  40. package/.opencode/command/generate-html.md +129 -0
  41. package/.opencode/plugin/techieflow.js +350 -0
  42. package/.tfcore/TOKEN-GUIDE.md +59 -0
  43. package/.tfcore/agents/analyst.md +97 -0
  44. package/.tfcore/agents/architect.md +84 -0
  45. package/.tfcore/agents/flow-master.md +217 -0
  46. package/.tfcore/agents/verifier.md +72 -0
  47. package/.tfcore/checklists/architect-checklist.md +438 -0
  48. package/.tfcore/core-config.yaml +47 -0
  49. package/.tfcore/data/brainstorming-techniques.md +36 -0
  50. package/.tfcore/data/elicitation-methods.md +154 -0
  51. package/.tfcore/data/techieflow-kb.md +807 -0
  52. package/.tfcore/data/technical-preferences.md +3 -0
  53. package/.tfcore/enhanced-ide-development-workflow.md +248 -0
  54. package/.tfcore/hooks/block-git.sh +301 -0
  55. package/.tfcore/hooks/codex-adapter.py +248 -0
  56. package/.tfcore/hooks/guard-artifacts.sh +101 -0
  57. package/.tfcore/hooks/guard-status-html.sh +102 -0
  58. package/.tfcore/hooks/guard-status.sh +124 -0
  59. package/.tfcore/hooks/guard-verify.sh +108 -0
  60. package/.tfcore/hooks/metrics-session.sh +129 -0
  61. package/.tfcore/hooks/session-pointer.sh +52 -0
  62. package/.tfcore/hooks/sweep-artifacts.sh +198 -0
  63. package/.tfcore/install-manifest.yaml +231 -0
  64. package/.tfcore/routing.yaml +105 -0
  65. package/.tfcore/tasks/_metrics-emit-gate.md +138 -0
  66. package/.tfcore/tasks/_smoke-test-policy.md +98 -0
  67. package/.tfcore/tasks/_status-update-gate.md +78 -0
  68. package/.tfcore/tasks/_yolo-mode.md +77 -0
  69. package/.tfcore/tasks/advanced-elicitation.md +117 -0
  70. package/.tfcore/tasks/amend-docs.md +149 -0
  71. package/.tfcore/tasks/author-brd.md +79 -0
  72. package/.tfcore/tasks/build-phase.md +231 -0
  73. package/.tfcore/tasks/create-deep-research-prompt.md +278 -0
  74. package/.tfcore/tasks/create-doc.md +101 -0
  75. package/.tfcore/tasks/day1-brownfield.md +507 -0
  76. package/.tfcore/tasks/day1-greenfield.md +224 -0
  77. package/.tfcore/tasks/devguide.md +224 -0
  78. package/.tfcore/tasks/document-project.md +343 -0
  79. package/.tfcore/tasks/execute-checklist.md +86 -0
  80. package/.tfcore/tasks/facilitate-brainstorming-session.md +136 -0
  81. package/.tfcore/tasks/fix-issues.md +134 -0
  82. package/.tfcore/tasks/generate-html.md +115 -0
  83. package/.tfcore/tasks/handoff-phase.md +126 -0
  84. package/.tfcore/tasks/index-docs.md +173 -0
  85. package/.tfcore/tasks/kb-mode-interaction.md +75 -0
  86. package/.tfcore/tasks/log-miss.md +160 -0
  87. package/.tfcore/tasks/metrics-report.md +143 -0
  88. package/.tfcore/tasks/mockups.md +122 -0
  89. package/.tfcore/tasks/productguide.md +105 -0
  90. package/.tfcore/tasks/refresh-status.md +135 -0
  91. package/.tfcore/tasks/render-workflow-docs.md +117 -0
  92. package/.tfcore/tasks/shard-doc.md +185 -0
  93. package/.tfcore/tasks/split-brd.md +131 -0
  94. package/.tfcore/tasks/triage-issues.md +157 -0
  95. package/.tfcore/tasks/verify-phase.md +579 -0
  96. package/.tfcore/telemetry/SCHEMA.md +678 -0
  97. package/.tfcore/telemetry/install-metrics.sh +390 -0
  98. package/.tfcore/telemetry/pre-commit +94 -0
  99. package/.tfcore/telemetry/tf-metrics.sh +1415 -0
  100. package/.tfcore/templates/architecture-tmpl.yaml +650 -0
  101. package/.tfcore/templates/brainstorming-output-tmpl.yaml +156 -0
  102. package/.tfcore/templates/brownfield-architecture-tmpl.yaml +476 -0
  103. package/.tfcore/templates/competitor-analysis-tmpl.yaml +306 -0
  104. package/.tfcore/templates/front-end-architecture-tmpl.yaml +218 -0
  105. package/.tfcore/templates/fullstack-architecture-tmpl.yaml +823 -0
  106. package/.tfcore/templates/market-research-tmpl.yaml +252 -0
  107. package/.tfcore/templates/project-brief-tmpl.yaml +221 -0
  108. package/.tfcore/templates/v4custom/app-agents-md-tmpl.md +61 -0
  109. package/.tfcore/templates/v4custom/app-architecture-tmpl.md +127 -0
  110. package/.tfcore/templates/v4custom/app-brd-tmpl.md +204 -0
  111. package/.tfcore/templates/v4custom/app-checklist-tmpl.md +90 -0
  112. package/.tfcore/templates/v4custom/app-claude-md-tmpl.md +33 -0
  113. package/.tfcore/templates/v4custom/app-devguide-tmpl.md +167 -0
  114. package/.tfcore/templates/v4custom/app-editorconfig-tmpl.editorconfig +44 -0
  115. package/.tfcore/templates/v4custom/app-library-feedback-tmpl.md +31 -0
  116. package/.tfcore/templates/v4custom/app-productguide-tmpl.md +54 -0
  117. package/.tfcore/templates/v4custom/app-project-status-tmpl.md +98 -0
  118. package/.tfcore/templates/v4custom/app-uidesign-tmpl.md +48 -0
  119. package/.tfcore/templates/v4custom/app-usageguide-tmpl.md +67 -0
  120. package/.tfcore/templates/v4custom/build-invocation-ladder.md +190 -0
  121. package/.tfcore/templates/v4custom/html-render-shell.md +502 -0
  122. package/.tfcore/templates/v4custom/metrics-report-template.md +273 -0
  123. package/.tfcore/templates/v4custom/opencode-operating-contract.md +56 -0
  124. package/.tfcore/user-guide.md +633 -0
  125. package/.tfcore/utils/techieflow-doc-template.md +325 -0
  126. package/.tfcore/utils/tf-assets.sh +310 -0
  127. package/.tfcore/utils/tf-codex-bind.py +196 -0
  128. package/.tfcore/utils/tf-codex-telemetry.py +60 -0
  129. package/.tfcore/utils/tf-emit.sh +1075 -0
  130. package/.tfcore/utils/tf-gitignore-audit.sh +281 -0
  131. package/.tfcore/utils/tf-goal.sh +421 -0
  132. package/.tfcore/utils/tf-harness.sh +160 -0
  133. package/.tfcore/utils/tf-mockup-parity.mjs +555 -0
  134. package/.tfcore/utils/tf-mockup-parity.sh +65 -0
  135. package/.tfcore/utils/tf-opencode-audit.py +126 -0
  136. package/.tfcore/utils/tf-perf.sh +241 -0
  137. package/.tfcore/utils/tf-render-html.py +715 -0
  138. package/.tfcore/utils/tf-render-html.sh +28 -0
  139. package/.tfcore/utils/tf-routing-bind.sh +216 -0
  140. package/.tfcore/utils/tf-routing.sh +247 -0
  141. package/.tfcore/utils/tf-yolo.sh +119 -0
  142. package/.tfcore/working-in-the-brownfield.md +606 -0
  143. package/LICENSE +201 -0
  144. package/README.md +1212 -0
  145. package/WORKFLOW.html +1986 -0
  146. package/docs/TechieFlow-Installation.md +299 -0
  147. package/opencode.jsonc +929 -0
  148. package/package.json +60 -0
  149. package/scripts/install.mjs +992 -0
  150. package/scripts/test-install.mjs +505 -0
  151. package/scripts/validate.mjs +155 -0
@@ -0,0 +1,807 @@
1
+ # TechieFlow Knowledge Base
2
+
3
+ ## Overview
4
+
5
+ TechieFlow™ (Breakthrough Method of Agile AI-driven Development) is a framework that combines AI agents with Agile development methodologies. The v4 system introduces a modular architecture with improved dependency management, bundle optimization, and support for both web and IDE environments.
6
+
7
+ ### Key Features
8
+
9
+ - **Modular Agent System**: Specialized AI agents for each Agile role
10
+ - **Build System**: Automated dependency resolution and optimization
11
+ - **Dual Environment Support**: Optimized for both web UIs and IDEs
12
+ - **Reusable Resources**: Portable templates, tasks, and checklists
13
+ - **Slash Command Integration**: Quick agent switching and control
14
+
15
+ ### When to Use TechieFlow
16
+
17
+ - **New Projects (Greenfield)**: Complete end-to-end development
18
+ - **Existing Projects (Brownfield)**: Feature additions and enhancements
19
+ - **Team Collaboration**: Multiple roles working together
20
+ - **Quality Assurance**: Structured testing and validation
21
+ - **Templates**: .tfcore/templates/v4custom/
22
+
23
+ ## How TechieFlow Works
24
+
25
+ ### The Core Method
26
+
27
+ TechieFlow transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
28
+
29
+ 1. **You Direct, AI Executes**: You provide vision and decisions; agents handle implementation details
30
+ 2. **Specialized Agents**: Each agent masters one role (PM, Developer, Architect, etc.)
31
+ 3. **Structured Workflows**: Proven patterns guide you from idea to deployed code
32
+ 4. **Clean Handoffs**: Fresh context windows ensure agents stay focused and effective
33
+
34
+ ### The Two-Phase Approach
35
+
36
+ #### Phase 1: Planning (Web UI - Cost Effective)
37
+
38
+ - Use large context windows (Gemini's 1M tokens)
39
+ - Generate comprehensive documents (PRD, Architecture)
40
+ - Leverage multiple agents for brainstorming
41
+ - Create once, use throughout development
42
+
43
+ #### Phase 2: Development (IDE - Implementation)
44
+
45
+ - Shard documents into manageable pieces
46
+ - Execute focused SM → Dev cycles
47
+ - One story at a time, sequential progress
48
+ - Real-time file operations and testing
49
+
50
+ ### The Development Loop
51
+
52
+ ```text
53
+ 1. SM Agent (New Chat) → Creates next story from sharded docs
54
+ 2. You → Review and approve story
55
+ 3. Dev Agent (New Chat) → Implements approved story
56
+ 4. QA Agent (New Chat) → Reviews and refactors code
57
+ 5. You → Verify completion
58
+ 6. Repeat until epic complete
59
+ ```
60
+
61
+ ### Why This Works
62
+
63
+ - **Context Optimization**: Clean chats = better AI performance
64
+ - **Role Clarity**: Agents don't context-switch = higher quality
65
+ - **Incremental Progress**: Small stories = manageable complexity
66
+ - **Human Oversight**: You validate each step = quality control
67
+ - **Document-Driven**: Specs guide everything = consistency
68
+
69
+ ## Getting Started
70
+
71
+ ### Quick Start Options
72
+
73
+ #### Option 1: Web UI
74
+
75
+ **Best for**: ChatGPT, Claude, Gemini users who want to start immediately
76
+
77
+ 1. Navigate to `dist/teams/`
78
+ 2. Copy `team-fullstack.txt` content
79
+ 3. Create new Gemini Gem or CustomGPT
80
+ 4. Upload file with instructions: "Your critical operating instructions are attached, do not break character as directed"
81
+ 5. Type `/help` to see available commands
82
+
83
+ #### Option 2: IDE Integration
84
+
85
+ **Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, Github Copilot users
86
+
87
+ ```bash
88
+ # Interactive installation (recommended)
89
+ # Use ./scaffold-greenfield.sh or ./scaffold-brownfield.sh — see WORKFLOW.html
90
+ ```
91
+
92
+ **Installation Steps**:
93
+
94
+ - Choose "Complete installation"
95
+ - Select your IDE from supported options:
96
+ - **Cursor**: Native AI integration
97
+ - **Claude Code**: Anthropic's official IDE
98
+ - **Windsurf**: Built-in AI capabilities
99
+ - **Trae**: Built-in AI capabilities
100
+ - **Cline**: VS Code extension with AI features
101
+ - **Roo Code**: Web-based IDE with agent support
102
+ - **GitHub Copilot**: VS Code extension with AI peer programming assistant
103
+ - **Auggie CLI (Augment Code)**: AI-powered development environment
104
+
105
+ **Note for VS Code Users**: TechieFlow™ assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run TechieFlow agents. The installer includes built-in support for Cline and Roo.
106
+
107
+ **Verify Installation**:
108
+
109
+ - `.tfcore/` folder created with all agents
110
+ - IDE-specific integration files created
111
+ - All agent commands/rules/modes available
112
+
113
+ **Remember**: At its core, TechieFlow™ is about mastering and harnessing prompt engineering. Any IDE with AI agent support can use TechieFlow - the framework provides the structured prompts and workflows that make AI development effective
114
+
115
+ ### Environment Selection Guide
116
+
117
+ **Use Web UI for**:
118
+
119
+ - Initial planning and documentation (PRD, architecture)
120
+ - Cost-effective document creation (especially with Gemini)
121
+ - Brainstorming and analysis phases
122
+ - Multi-agent consultation and planning
123
+
124
+ **Use IDE for**:
125
+
126
+ - Active development and coding
127
+ - File operations and project integration
128
+ - Document sharding and story management
129
+ - Implementation workflow (SM/Dev cycles)
130
+
131
+ **Cost-Saving Tip**: Create large documents (PRDs, architecture) in web UI, then copy to `docs/prd.md` and `docs/architecture.md` in your project before switching to IDE for development.
132
+
133
+ ### IDE-Only Workflow Considerations
134
+
135
+ **Can you do everything in IDE?** Yes, but understand the tradeoffs:
136
+
137
+ **Pros of IDE-Only**:
138
+
139
+ - Single environment workflow
140
+ - Direct file operations from start
141
+ - No copy/paste between environments
142
+ - Immediate project integration
143
+
144
+ **Cons of IDE-Only**:
145
+
146
+ - Higher token costs for large document creation
147
+ - Smaller context windows (varies by IDE/model)
148
+ - May hit limits during planning phases
149
+ - Less cost-effective for brainstorming
150
+
151
+ **Using Web Agents in IDE**:
152
+
153
+ - **NOT RECOMMENDED**: Web agents (PM, Architect) have rich dependencies designed for large contexts
154
+ - **Why it matters**: Dev agents are kept lean to maximize coding context
155
+ - **The principle**: "Dev agents code, planning agents plan" - mixing breaks this optimization
156
+
157
+ **About flow-master and flow-master**:
158
+
159
+ - **flow-master**: CAN do any task without switching agents, BUT...
160
+ - **Still use specialized agents for planning**: PM, Architect, and UX Expert have tuned personas that produce better results
161
+ - **Why specialization matters**: Each agent's personality and focus creates higher quality outputs
162
+ - **If using flow-master/orchestrator**: Fine for planning phases, but...
163
+
164
+ **CRITICAL RULE for Development**:
165
+
166
+ - **ALWAYS use SM agent for story creation** - Never use flow-master or flow-master
167
+ - **ALWAYS use Dev agent for implementation** - Never use flow-master or flow-master
168
+ - **Why this matters**: SM and Dev agents are specifically optimized for the development workflow
169
+ - **No exceptions**: Even if using flow-master for everything else, switch to SM → Dev for implementation
170
+
171
+ **Best Practice for IDE-Only**:
172
+
173
+ 1. Use PM/Architect/UX agents for planning (better than flow-master)
174
+ 2. Create documents directly in project
175
+ 3. Shard immediately after creation
176
+ 4. **MUST switch to SM agent** for story creation
177
+ 5. **MUST switch to Dev agent** for implementation
178
+ 6. Keep planning and coding in separate chat sessions
179
+
180
+ ## Core Configuration (core-config.yaml)
181
+
182
+ **New in V4**: The `.tfcore/core-config.yaml` file is a critical innovation that enables TechieFlow to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
183
+
184
+ ### What is core-config.yaml?
185
+
186
+ This configuration file acts as a map for TechieFlow agents, telling them exactly where to find your project documents and how they're structured. It enables:
187
+
188
+ - **Version Flexibility**: Work with V3, V4, or custom document structures
189
+ - **Custom Locations**: Define where your documents and shards live
190
+ - **Developer Context**: Specify which files the dev agent should always load
191
+ - **Debug Support**: Built-in logging for troubleshooting
192
+
193
+ ### Key Configuration Areas
194
+
195
+ #### PRD Configuration
196
+
197
+ - **prdVersion**: Tells agents if PRD follows v3 or v4 conventions
198
+ - **prdSharded**: Whether epics are embedded (false) or in separate files (true)
199
+ - **prdShardedLocation**: Where to find sharded epic files
200
+ - **epicFilePattern**: Pattern for epic filenames (e.g., `epic-{n}*.md`)
201
+
202
+ #### Architecture Configuration
203
+
204
+ - **architectureVersion**: v3 (monolithic) or v4 (sharded)
205
+ - **architectureSharded**: Whether architecture is split into components
206
+ - **architectureShardedLocation**: Where sharded architecture files live
207
+
208
+ #### Developer Files
209
+
210
+ - **devLoadAlwaysFiles**: List of files the dev agent loads for every task
211
+ - **devDebugLog**: Where dev agent logs repeated failures
212
+ - **agentCoreDump**: Export location for chat conversations
213
+
214
+ ### Why It Matters
215
+
216
+ 1. **No Forced Migrations**: Keep your existing document structure
217
+ 2. **Gradual Adoption**: Start with V3 and migrate to V4 at your pace
218
+ 3. **Custom Workflows**: Configure TechieFlow to match your team's process
219
+ 4. **Intelligent Agents**: Agents automatically adapt to your configuration
220
+
221
+ ### Common Configurations
222
+
223
+ **Legacy V3 Project**:
224
+
225
+ ```yaml
226
+ prdVersion: v3
227
+ prdSharded: false
228
+ architectureVersion: v3
229
+ architectureSharded: false
230
+ ```
231
+
232
+ **V4 Optimized Project**:
233
+
234
+ ```yaml
235
+ prdVersion: v4
236
+ prdSharded: true
237
+ prdShardedLocation: docs/prd
238
+ architectureVersion: v4
239
+ architectureSharded: true
240
+ architectureShardedLocation: docs/architecture
241
+ ```
242
+
243
+ ## Core Philosophy
244
+
245
+ ### Vibe CEO'ing
246
+
247
+ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a singular vision. Your AI agents are your high-powered team, and your role is to:
248
+
249
+ - **Direct**: Provide clear instructions and objectives
250
+ - **Refine**: Iterate on outputs to achieve quality
251
+ - **Oversee**: Maintain strategic alignment across all agents
252
+
253
+ ### Core Principles
254
+
255
+ 1. **MAXIMIZE_AI_LEVERAGE**: Push the AI to deliver more. Challenge outputs and iterate.
256
+ 2. **QUALITY_CONTROL**: You are the ultimate arbiter of quality. Review all outputs.
257
+ 3. **STRATEGIC_OVERSIGHT**: Maintain the high-level vision and ensure alignment.
258
+ 4. **ITERATIVE_REFINEMENT**: Expect to revisit steps. This is not a linear process.
259
+ 5. **CLEAR_INSTRUCTIONS**: Precise requests lead to better outputs.
260
+ 6. **DOCUMENTATION_IS_KEY**: Good inputs (briefs, PRDs) lead to good outputs.
261
+ 7. **START_SMALL_SCALE_FAST**: Test concepts, then expand.
262
+ 8. **EMBRACE_THE_CHAOS**: Adapt and overcome challenges.
263
+
264
+ ### Key Workflow Principles
265
+
266
+ 1. **Agent Specialization**: Each agent has specific expertise and responsibilities
267
+ 2. **Clean Handoffs**: Always start fresh when switching between agents
268
+ 3. **Status Tracking**: Maintain story statuses (Draft → Approved → InProgress → Done)
269
+ 4. **Iterative Development**: Complete one story before starting the next
270
+ 5. **Documentation First**: Always start with solid PRD and architecture
271
+
272
+ ## Agent System
273
+
274
+ ### Core Development Team
275
+
276
+ | Agent | Role | Primary Functions | When to Use |
277
+ | ----------- | ------------------ | --------------------------------------- | -------------------------------------- |
278
+ | `analyst` | Business Analyst | Market research, requirements gathering | Project planning, competitive analysis |
279
+ | `pm` | Product Manager | PRD creation, feature prioritization | Strategic planning, roadmaps |
280
+ | `architect` | Solution Architect | System design, technical architecture | Complex systems, scalability planning |
281
+ | `dev` | Developer | Code implementation, debugging | All development tasks |
282
+ | `qa` | QA Specialist | Test planning, quality assurance | Testing strategies, bug validation |
283
+ | `ux-expert` | UX Designer | UI/UX design, prototypes | User experience, interface design |
284
+ | `po` | Product Owner | Backlog management, story validation | Story refinement, acceptance criteria |
285
+ | `sm` | Scrum Master | Sprint planning, story creation | Project management, workflow |
286
+
287
+ ### Meta Agents
288
+
289
+ | Agent | Role | Primary Functions | When to Use |
290
+ | ------------------- | ---------------- | ------------------------------------- | --------------------------------- |
291
+ | `flow-master` | Team Coordinator | Multi-agent workflows, role switching | Complex multi-role tasks |
292
+ | `flow-master` | Universal Expert | All capabilities without switching | Single-session comprehensive work |
293
+
294
+ ### Agent Interaction Commands
295
+
296
+ #### IDE-Specific Syntax
297
+
298
+ **Agent Loading by IDE**:
299
+
300
+ - **Claude Code**: `/agent-name` (e.g., `/flow-master`)
301
+ - **Cursor**: `@agent-name` (e.g., `@flow-master`)
302
+ - **Windsurf**: `/agent-name` (e.g., `/flow-master`)
303
+ - **Trae**: `@agent-name` (e.g., `@flow-master`)
304
+ - **Roo Code**: Select mode from mode selector (e.g., `flow-master`)
305
+ - **GitHub Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
306
+
307
+ **Chat Management Guidelines**:
308
+
309
+ - **Claude Code, Cursor, Windsurf, Trae**: Start new chats when switching agents
310
+ - **Roo Code**: Switch modes within the same conversation
311
+
312
+ **Common Task Commands**:
313
+
314
+ - `*help` - Show available commands
315
+ - `*status` - Show current context/progress
316
+ - `*exit` - Exit the agent mode
317
+ - `*shard-doc docs/prd.md prd` - Shard PRD into manageable pieces
318
+ - `*shard-doc docs/architecture.md architecture` - Shard architecture document
319
+ - `*create` - Run create-next-story task (SM agent)
320
+
321
+ **In Web UI**:
322
+
323
+ ```text
324
+ /pm create-doc prd
325
+ /architect review system design
326
+ /dev implement story 1.2
327
+ /help - Show available commands
328
+ /switch agent-name - Change active agent (if orchestrator available)
329
+ ```
330
+
331
+ ## Team Configurations
332
+
333
+ ### Pre-Built Teams
334
+
335
+ #### Team All
336
+
337
+ - **Includes**: All 10 agents + orchestrator
338
+ - **Use Case**: Complete projects requiring all roles
339
+ - **Bundle**: `team-all.txt`
340
+
341
+ #### Team Fullstack
342
+
343
+ - **Includes**: PM, Architect, Developer, QA, UX Expert
344
+ - **Use Case**: End-to-end web/mobile development
345
+ - **Bundle**: `team-fullstack.txt`
346
+
347
+ #### Team No-UI
348
+
349
+ - **Includes**: PM, Architect, Developer, QA (no UX Expert)
350
+ - **Use Case**: Backend services, APIs, system development
351
+ - **Bundle**: `team-no-ui.txt`
352
+
353
+ ## Core Architecture
354
+
355
+ ### System Overview
356
+
357
+ The TechieFlow™ is built around a modular architecture centered on the `techieflow-core` directory, which serves as the brain of the entire system. This design enables the framework to operate effectively in both IDE environments (like Cursor, VS Code) and web-based AI interfaces (like ChatGPT, Gemini).
358
+
359
+ ### Key Architectural Components
360
+
361
+ #### 1. Agents (`techieflow-core/agents/`)
362
+
363
+ - **Purpose**: Each markdown file defines a specialized AI agent for a specific Agile role (PM, Dev, Architect, etc.)
364
+ - **Structure**: Contains YAML headers specifying the agent's persona, capabilities, and dependencies
365
+ - **Dependencies**: Lists of tasks, templates, checklists, and data files the agent can use
366
+ - **Startup Instructions**: Can load project-specific documentation for immediate context
367
+
368
+ #### 2. Agent Teams (`techieflow-core/agent-teams/`)
369
+
370
+ - **Purpose**: Define collections of agents bundled together for specific purposes
371
+ - **Examples**: `team-all.yaml` (comprehensive bundle), `team-fullstack.yaml` (full-stack development)
372
+ - **Usage**: Creates pre-packaged contexts for web UI environments
373
+
374
+ #### 3. Workflows (`techieflow-core/workflows/`)
375
+
376
+ - **Purpose**: YAML files defining prescribed sequences of steps for specific project types
377
+ - **Types**: Greenfield (new projects) and Brownfield (existing projects) for UI, service, and fullstack development
378
+ - **Structure**: Defines agent interactions, artifacts created, and transition conditions
379
+
380
+ #### 4. Reusable Resources
381
+
382
+ - **Templates** (`techieflow-core/templates/`): Markdown templates for PRDs, architecture specs, user stories
383
+ - **Tasks** (`techieflow-core/tasks/`): Instructions for specific repeatable actions like "shard-doc" or "create-next-story"
384
+ - **Checklists** (`techieflow-core/checklists/`): Quality assurance checklists for validation and review
385
+ - **Data** (`techieflow-core/data/`): Core knowledge base and technical preferences
386
+
387
+ ### Dual Environment Architecture
388
+
389
+ #### IDE Environment
390
+
391
+ - Users interact directly with agent markdown files
392
+ - Agents can access all dependencies dynamically
393
+ - Supports real-time file operations and project integration
394
+ - Optimized for development workflow execution
395
+
396
+ #### Web UI Environment
397
+
398
+ - Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assets with an orchestrating agent
399
+ - Single text files containing all agent dependencies are in `dist/agents/` - these are unnecessary unless you want to create a web agent that is only a single agent and not a team
400
+ - Created by the web-builder tool for upload to web interfaces
401
+ - Provides complete context in one package
402
+
403
+ ### Template Processing System
404
+
405
+ TechieFlow employs a sophisticated template system with three key components:
406
+
407
+ 1. **Template Format** (`utils/techieflow-doc-template.md`): Defines markup language for variable substitution and AI processing directives from yaml templates
408
+ 2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction to transform yaml spec to final markdown output
409
+ 3. **Advanced Elicitation** (`tasks/advanced-elicitation.md`): Provides interactive refinement through structured brainstorming
410
+
411
+ ### Technical Preferences Integration
412
+
413
+ The `technical-preferences.md` file serves as a persistent technical profile that:
414
+
415
+ - Ensures consistency across all agents and projects
416
+ - Eliminates repetitive technology specification
417
+ - Provides personalized recommendations aligned with user preferences
418
+ - Evolves over time with lessons learned
419
+
420
+ ### Build and Delivery Process
421
+
422
+ The `web-builder.js` tool creates web-ready bundles by:
423
+
424
+ 1. Reading agent or team definition files
425
+ 2. Recursively resolving all dependencies
426
+ 3. Concatenating content into single text files with clear separators
427
+ 4. Outputting ready-to-upload bundles for web AI interfaces
428
+
429
+ This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes TechieFlow powerful.
430
+
431
+ ## Complete Development Workflow
432
+
433
+ ### Planning Phase (Web UI Recommended - Especially Gemini!)
434
+
435
+ **Ideal for cost efficiency with Gemini's massive context:**
436
+
437
+ **For Brownfield Projects - Start Here!**:
438
+
439
+ 1. **Upload entire project to Gemini Web** (GitHub URL, files, or zip)
440
+ 2. **Document existing system**: `/analyst` → `*document-project`
441
+ 3. **Creates comprehensive docs** from entire codebase analysis
442
+
443
+ **For All Projects**:
444
+
445
+ 1. **Optional Analysis**: `/analyst` - Market research, competitive analysis
446
+ 2. **Project Brief**: Create foundation document (Analyst or user)
447
+ 3. **PRD Creation**: `/pm create-doc prd` - Comprehensive product requirements
448
+ 4. **Architecture Design**: `/architect create-doc architecture` - Technical foundation
449
+ 5. **Validation & Alignment**: `/po` run master checklist to ensure document consistency
450
+ 6. **Document Preparation**: Copy final documents to project as `docs/prd.md` and `docs/architecture.md`
451
+
452
+ #### Example Planning Prompts
453
+
454
+ **For PRD Creation**:
455
+
456
+ ```text
457
+ "I want to build a [type] application that [core purpose].
458
+ Help me brainstorm features and create a comprehensive PRD."
459
+ ```
460
+
461
+ **For Architecture Design**:
462
+
463
+ ```text
464
+ "Based on this PRD, design a scalable technical architecture
465
+ that can handle [specific requirements]."
466
+ ```
467
+
468
+ ### Critical Transition: Web UI to IDE
469
+
470
+ **Once planning is complete, you MUST switch to IDE for development:**
471
+
472
+ - **Why**: Development workflow requires file operations, real-time project integration, and document sharding
473
+ - **Cost Benefit**: Web UI is more cost-effective for large document creation; IDE is optimized for development tasks
474
+ - **Required Files**: Ensure `docs/prd.md` and `docs/architecture.md` exist in your project
475
+
476
+ ### IDE Development Workflow
477
+
478
+ **Prerequisites**: Planning documents must exist in `docs/` folder
479
+
480
+ 1. **Document Sharding** (CRITICAL STEP):
481
+ - Documents created by PM/Architect (in Web or IDE) MUST be sharded for development
482
+ - Two methods to shard:
483
+ a) **Manual**: Drag `shard-doc` task + document file into chat
484
+ b) **Agent**: Ask `@flow-master` or `@po` to shard documents
485
+ - Shards `docs/prd.md` → `docs/prd/` folder
486
+ - Shards `docs/architecture.md` → `docs/architecture/` folder
487
+ - **WARNING**: Do NOT shard in Web UI - copying many small files is painful!
488
+
489
+ 2. **Verify Sharded Content**:
490
+ - At least one `epic-n.md` file in `docs/prd/` with stories in development order
491
+ - Source tree document and coding standards for dev agent reference
492
+ - Sharded docs for SM agent story creation
493
+
494
+ Resulting Folder Structure:
495
+
496
+ - `docs/prd/` - Broken down PRD sections
497
+ - `docs/architecture/` - Broken down architecture sections
498
+ - `docs/stories/` - Generated user stories
499
+
500
+ 1. **Development Cycle** (Sequential, one story at a time):
501
+
502
+ **CRITICAL CONTEXT MANAGEMENT**:
503
+ - **Context windows matter!** Always use fresh, clean context windows
504
+ - **Model selection matters!** Use most powerful thinking model for SM story creation
505
+ - **ALWAYS start new chat between SM, Dev, and QA work**
506
+
507
+ **Step 1 - Story Creation**:
508
+ - **NEW CLEAN CHAT** → Select powerful model → `@sm` → `*create`
509
+ - SM executes create-next-story task
510
+ - Review generated story in `docs/stories/`
511
+ - Update status from "Draft" to "Approved"
512
+
513
+ **Step 2 - Story Implementation**:
514
+ - **NEW CLEAN CHAT** → `@dev`
515
+ - Agent asks which story to implement
516
+ - Include story file content to save dev agent lookup time
517
+ - Dev follows tasks/subtasks, marking completion
518
+ - Dev maintains File List of all changes
519
+ - Dev marks story as "Review" when complete with all tests passing
520
+
521
+ **Step 3 - Senior QA Review**:
522
+ - **NEW CLEAN CHAT** → `@qa` → execute review-story task
523
+ - QA performs senior developer code review
524
+ - QA can refactor and improve code directly
525
+ - QA appends results to story's QA Results section
526
+ - If approved: Status → "Done"
527
+ - If changes needed: Status stays "Review" with unchecked items for dev
528
+
529
+ **Step 4 - Repeat**: Continue SM → Dev → QA cycle until all epic stories complete
530
+
531
+ **Important**: Only 1 story in progress at a time, worked sequentially until all epic stories complete.
532
+
533
+ ### Status Tracking Workflow
534
+
535
+ Stories progress through defined statuses:
536
+
537
+ - **Draft** → **Approved** → **InProgress** → **Done**
538
+
539
+ Each status change requires user verification and approval before proceeding.
540
+
541
+ ### Workflow Types
542
+
543
+ #### Greenfield Development
544
+
545
+ - Business analysis and market research
546
+ - Product requirements and feature definition
547
+ - System architecture and design
548
+ - Development execution
549
+ - Testing and deployment
550
+
551
+ #### Brownfield Enhancement (Existing Projects)
552
+
553
+ **Key Concept**: Brownfield development requires comprehensive documentation of your existing project for AI agents to understand context, patterns, and constraints.
554
+
555
+ **Complete Brownfield Workflow Options**:
556
+
557
+ **Option 1: PRD-First (Recommended for Large Codebases/Monorepos)**:
558
+
559
+ 1. **Upload project to Gemini Web** (GitHub URL, files, or zip)
560
+ 2. **Create PRD first**: `@pm` → `*create-doc brownfield-prd`
561
+ 3. **Focused documentation**: `@analyst` → `*document-project`
562
+ - Analyst asks for focus if no PRD provided
563
+ - Choose "single document" format for Web UI
564
+ - Uses PRD to document ONLY relevant areas
565
+ - Creates one comprehensive markdown file
566
+ - Avoids bloating docs with unused code
567
+
568
+ **Option 2: Document-First (Good for Smaller Projects)**:
569
+
570
+ 1. **Upload project to Gemini Web**
571
+ 2. **Document everything**: `@analyst` → `*document-project`
572
+ 3. **Then create PRD**: `@pm` → `*create-doc brownfield-prd`
573
+ - More thorough but can create excessive documentation
574
+
575
+ 4. **Requirements Gathering**:
576
+ - **Brownfield PRD**: Use PM agent with `brownfield-prd-tmpl`
577
+ - **Analyzes**: Existing system, constraints, integration points
578
+ - **Defines**: Enhancement scope, compatibility requirements, risk assessment
579
+ - **Creates**: Epic and story structure for changes
580
+
581
+ 5. **Architecture Planning**:
582
+ - **Brownfield Architecture**: Use Architect agent with `brownfield-architecture-tmpl`
583
+ - **Integration Strategy**: How new features integrate with existing system
584
+ - **Migration Planning**: Gradual rollout and backwards compatibility
585
+ - **Risk Mitigation**: Addressing potential breaking changes
586
+
587
+ **Brownfield-Specific Resources**:
588
+
589
+ **Templates**:
590
+
591
+ - `brownfield-prd-tmpl.md`: Comprehensive enhancement planning with existing system analysis
592
+ - `brownfield-architecture-tmpl.md`: Integration-focused architecture for existing systems
593
+
594
+ **Tasks**:
595
+
596
+ - `document-project`: Generates comprehensive documentation from existing codebase
597
+ - `brownfield-create-epic`: Creates single epic for focused enhancements (when full PRD is overkill)
598
+ - `brownfield-create-story`: Creates individual story for small, isolated changes
599
+
600
+ **When to Use Each Approach**:
601
+
602
+ **Full Brownfield Workflow** (Recommended for):
603
+
604
+ - Major feature additions
605
+ - System modernization
606
+ - Complex integrations
607
+ - Multiple related changes
608
+
609
+ **Quick Epic/Story Creation** (Use when):
610
+
611
+ - Single, focused enhancement
612
+ - Isolated bug fixes
613
+ - Small feature additions
614
+ - Well-documented existing system
615
+
616
+ **Critical Success Factors**:
617
+
618
+ 1. **Documentation First**: Always run `document-project` if docs are outdated/missing
619
+ 2. **Context Matters**: Provide agents access to relevant code sections
620
+ 3. **Integration Focus**: Emphasize compatibility and non-breaking changes
621
+ 4. **Incremental Approach**: Plan for gradual rollout and testing
622
+
623
+ **For detailed guide**: See `docs/working-in-the-brownfield.md`
624
+
625
+ ## Document Creation Best Practices
626
+
627
+ ### Required File Naming for Framework Integration
628
+
629
+ - `docs/prd.md` - Product Requirements Document
630
+ - `docs/architecture.md` - System Architecture Document
631
+
632
+ **Why These Names Matter**:
633
+
634
+ - Agents automatically reference these files during development
635
+ - Sharding tasks expect these specific filenames
636
+ - Workflow automation depends on standard naming
637
+
638
+ ### Cost-Effective Document Creation Workflow
639
+
640
+ **Recommended for Large Documents (PRD, Architecture):**
641
+
642
+ 1. **Use Web UI**: Create documents in web interface for cost efficiency
643
+ 2. **Copy Final Output**: Save complete markdown to your project
644
+ 3. **Standard Names**: Save as `docs/prd.md` and `docs/architecture.md`
645
+ 4. **Switch to IDE**: Use IDE agents for development and smaller documents
646
+
647
+ ### Document Sharding
648
+
649
+ Templates with Level 2 headings (`##`) can be automatically sharded:
650
+
651
+ **Original PRD**:
652
+
653
+ ```markdown
654
+ ## Goals and Background Context
655
+
656
+ ## Requirements
657
+
658
+ ## User Interface Design Goals
659
+
660
+ ## Success Metrics
661
+ ```
662
+
663
+ **After Sharding**:
664
+
665
+ - `docs/prd/goals-and-background-context.md`
666
+ - `docs/prd/requirements.md`
667
+ - `docs/prd/user-interface-design-goals.md`
668
+ - `docs/prd/success-metrics.md`
669
+
670
+ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sharding.
671
+
672
+ ## Usage Patterns and Best Practices
673
+
674
+ ### Environment-Specific Usage
675
+
676
+ **Web UI Best For**:
677
+
678
+ - Initial planning and documentation phases
679
+ - Cost-effective large document creation
680
+ - Agent consultation and brainstorming
681
+ - Multi-agent workflows with orchestrator
682
+
683
+ **IDE Best For**:
684
+
685
+ - Active development and implementation
686
+ - File operations and project integration
687
+ - Story management and development cycles
688
+ - Code review and debugging
689
+
690
+ ### Quality Assurance
691
+
692
+ - Use appropriate agents for specialized tasks
693
+ - Follow Agile ceremonies and review processes
694
+ - Maintain document consistency with PO agent
695
+ - Regular validation with checklists and templates
696
+
697
+ ### Performance Optimization
698
+
699
+ - Use specific agents vs. `flow-master` for focused tasks
700
+ - Choose appropriate team size for project needs
701
+ - Leverage technical preferences for consistency
702
+ - Regular context management and cache clearing
703
+
704
+ ## Success Tips
705
+
706
+ - **Use Gemini for big picture planning** - The team-fullstack bundle provides collaborative expertise
707
+ - **Use flow-master for document organization** - Sharding creates manageable chunks
708
+ - **Follow the SM → Dev cycle religiously** - This ensures systematic progress
709
+ - **Keep conversations focused** - One agent, one task per conversation
710
+ - **Review everything** - Always review and approve before marking complete
711
+
712
+ ## Contributing to TechieFlow™
713
+
714
+ ### Quick Contribution Guidelines
715
+
716
+ For full details, see `CONTRIBUTING.md`. Key points:
717
+
718
+ **Fork Workflow**:
719
+
720
+ 1. Fork the repository
721
+ 2. Create feature branches
722
+ 3. Submit PRs to `next` branch (default) or `main` for critical fixes only
723
+ 4. Keep PRs small: 200-400 lines ideal, 800 lines maximum
724
+ 5. One feature/fix per PR
725
+
726
+ **PR Requirements**:
727
+
728
+ - Clear descriptions (max 200 words) with What/Why/How/Testing
729
+ - Use conventional commits (feat:, fix:, docs:)
730
+ - Atomic commits - one logical change per commit
731
+ - Must align with guiding principles
732
+
733
+ **Core Principles** (from docs/GUIDING-PRINCIPLES.md):
734
+
735
+ - **Dev Agents Must Be Lean**: Minimize dependencies, save context for code
736
+ - **Natural Language First**: Everything in markdown, no code in core
737
+ - **Core vs Expansion Packs**: Core for universal needs, packs for specialized domains
738
+ - **Design Philosophy**: "Dev agents code, planning agents plan"
739
+
740
+ ## Expansion Packs
741
+
742
+ ### What Are Expansion Packs?
743
+
744
+ Expansion packs extend TechieFlow™ beyond traditional software development into ANY domain. They provide specialized agent teams, templates, and workflows while keeping the core framework lean and focused on development.
745
+
746
+ ### Why Use Expansion Packs?
747
+
748
+ 1. **Keep Core Lean**: Dev agents maintain maximum context for coding
749
+ 2. **Domain Expertise**: Deep, specialized knowledge without bloating core
750
+ 3. **Community Innovation**: Anyone can create and share packs
751
+ 4. **Modular Design**: Install only what you need
752
+
753
+ ### Available Expansion Packs
754
+
755
+ **Technical Packs**:
756
+
757
+ - **Infrastructure/DevOps**: Cloud architects, SRE experts, security specialists
758
+ - **Game Development**: Game designers, level designers, narrative writers
759
+ - **Mobile Development**: iOS/Android specialists, mobile UX experts
760
+ - **Data Science**: ML engineers, data scientists, visualization experts
761
+
762
+ **Non-Technical Packs**:
763
+
764
+ - **Business Strategy**: Consultants, financial analysts, marketing strategists
765
+ - **Creative Writing**: Plot architects, character developers, world builders
766
+ - **Health & Wellness**: Fitness trainers, nutritionists, habit engineers
767
+ - **Education**: Curriculum designers, assessment specialists
768
+ - **Legal Support**: Contract analysts, compliance checkers
769
+
770
+ **Specialty Packs**:
771
+
772
+ - **Expansion Creator**: Tools to build your own expansion packs
773
+ - **RPG Game Master**: Tabletop gaming assistance
774
+ - **Life Event Planning**: Wedding planners, event coordinators
775
+ - **Scientific Research**: Literature reviewers, methodology designers
776
+
777
+ ### Using Expansion Packs
778
+
779
+ 1. **Browse Available Packs**: Check `expansion-packs/` directory
780
+ 2. **Get Inspiration**: See `docs/expansion-packs.md` for detailed examples and ideas
781
+ 3. **Install via CLI**:
782
+
783
+ ```bash
784
+ # Use ./scaffold-greenfield.sh or ./scaffold-brownfield.sh — see WORKFLOW.html
785
+ # Select "Install expansion pack" option
786
+ ```
787
+
788
+ 4. **Use in Your Workflow**: Installed packs integrate seamlessly with existing agents
789
+
790
+ ### Creating Custom Expansion Packs
791
+
792
+ Use the **expansion-creator** pack to build your own:
793
+
794
+ 1. **Define Domain**: What expertise are you capturing?
795
+ 2. **Design Agents**: Create specialized roles with clear boundaries
796
+ 3. **Build Resources**: Tasks, templates, checklists for your domain
797
+ 4. **Test & Share**: Validate with real use cases, share with community
798
+
799
+ **Key Principle**: Expansion packs democratize expertise by making specialized knowledge accessible through AI agents.
800
+
801
+ ## Getting Help
802
+
803
+ - **Commands**: Use `*/*help` in any environment to see available commands
804
+ - **Agent Switching**: Use `*/*switch agent-name` with orchestrator for role changes
805
+ - **Templates**: .tfcore/templates/v4custom/
806
+ - **Community**: Discord and GitHub resources available for support
807
+ - **Contributing**: See `CONTRIBUTING.md` for full guidelines