@akm1923main/init-project 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 (36) hide show
  1. package/QUICKSTART_CREATE_AI_PROJECT.md +52 -0
  2. package/README.md +48 -0
  3. package/index.js +219 -0
  4. package/package.json +24 -0
  5. package/templates/02_Skills/Legacy_Prompts/Architecture.md +72 -0
  6. package/templates/02_Skills/Legacy_Prompts/Coding_Discipline.md +283 -0
  7. package/templates/02_Skills/Legacy_Prompts/Generate_prd.md +129 -0
  8. package/templates/02_Skills/Legacy_Prompts/IDEA.md +188 -0
  9. package/templates/02_Skills/Legacy_Prompts/Sharder.md +359 -0
  10. package/templates/02_Skills/agents/Architect.md +453 -0
  11. package/templates/02_Skills/agents/Business_Analyst.md +341 -0
  12. package/templates/02_Skills/agents/Deployment_Engineer.md +371 -0
  13. package/templates/02_Skills/agents/DevOps_Engineer.md +356 -0
  14. package/templates/02_Skills/agents/Documentation_Writer.md +371 -0
  15. package/templates/02_Skills/agents/Idea_Analyst.md +334 -0
  16. package/templates/02_Skills/agents/Master_Orchestrator.md +197 -0
  17. package/templates/02_Skills/agents/Performance_Engineer.md +316 -0
  18. package/templates/02_Skills/agents/Product_Manager.md +344 -0
  19. package/templates/02_Skills/agents/Refactor_Specialist.md +8 -0
  20. package/templates/02_Skills/agents/Security_Engineer.md +360 -0
  21. package/templates/02_Skills/agents/Staff_Engineer.md +306 -0
  22. package/templates/02_Skills/agents/Testing_Engineer.md +312 -0
  23. package/templates/02_Skills/workflows/architecture_generation_workflow.md +73 -0
  24. package/templates/02_Skills/workflows/business_analysis_workflow.md +70 -0
  25. package/templates/02_Skills/workflows/deployment_workflow.md +31 -0
  26. package/templates/02_Skills/workflows/devops_setup_workflow.md +30 -0
  27. package/templates/02_Skills/workflows/documentation_workflow.md +352 -0
  28. package/templates/02_Skills/workflows/idea_refinement_workflow.md +106 -0
  29. package/templates/02_Skills/workflows/performance_review_workflow.md +29 -0
  30. package/templates/02_Skills/workflows/prd_generation_workflow.md +83 -0
  31. package/templates/02_Skills/workflows/refactor_workflow.md +35 -0
  32. package/templates/02_Skills/workflows/security_audit_workflow.md +30 -0
  33. package/templates/02_Skills/workflows/task_execution_workflow.md +33 -0
  34. package/templates/02_Skills/workflows/task_generation_workflow.md +61 -0
  35. package/templates/02_Skills/workflows/testing_workflow.md +31 -0
  36. package/templates/02_Skills/workflows/workflow_governance_rules.md +112 -0
@@ -0,0 +1,352 @@
1
+ ---
2
+ # 📄 documentation_workflow.md (Enterprise 9.5+)
3
+
4
+ ```md
5
+ # 📘 Documentation Workflow (Enterprise Documentation Enforcement Layer)
6
+ ---
7
+ # 1️⃣ Phase Objective
8
+
9
+ Transform:
10
+
11
+ - PRD
12
+ - Architecture
13
+ - Folder Structure
14
+ - Implementation Structure
15
+ - Decisions Log
16
+
17
+ Into:
18
+
19
+ - Professional-grade system documentation
20
+ - Beginner-friendly explanation
21
+ - Component-wise documentation
22
+ - Visual diagrams (Mermaid + ASCII)
23
+ - Folder-level explanations
24
+ - Failure + security explanations
25
+
26
+ This workflow prevents:
27
+
28
+ - Shallow documentation
29
+ - Architecture-document mismatch
30
+ - Missing component explanation
31
+ - No diagrams
32
+ - Copy-paste generic docs
33
+ - Onboarding confusion
34
+
35
+ ---
36
+
37
+ # 2️⃣ Authority & Scope Boundaries
38
+
39
+ This workflow IS authorized to:
40
+
41
+ - Explain architecture
42
+ - Explain folder structure
43
+ - Generate diagrams
44
+ - Create component-level docs
45
+ - Add clarity layers
46
+ - Add beginner explanations
47
+
48
+ This workflow is NOT authorized to:
49
+
50
+ - Change architecture
51
+ - Modify PRD
52
+ - Invent new features
53
+ - Alter code
54
+ - Redefine component boundaries
55
+
56
+ If inconsistencies found:
57
+ → Escalate to Architect.
58
+
59
+ ---
60
+
61
+ # 3️⃣ Entry Preconditions (STRICT GATE)
62
+
63
+ Before starting documentation:
64
+
65
+ - [ ] PRD.md exists
66
+ - [ ] ARCHITECTURE.md exists
67
+ - [ ] Folder structure stable
68
+ - [ ] No open architectural blockers
69
+ - [ ] Execution phase complete OR architecture finalized
70
+ - [ ] PROJECT_STATE.md updated to appropriate phase
71
+
72
+ If not satisfied → STOP.
73
+
74
+ ---
75
+
76
+ # 4️⃣ Required Inputs
77
+
78
+ You MUST read:
79
+
80
+ - PRD.md
81
+ - ARCHITECTURE.md
82
+ - 05_Project/ folder structure
83
+ - state/DECISIONS.md
84
+ - PROJECT_STATE.md
85
+ - DEVELOPMENT_CHECKLIST.md (if execution done)
86
+
87
+ Missing any → STOP.
88
+
89
+ ---
90
+
91
+ # 5️⃣ Documentation Coverage Planning
92
+
93
+ Before writing documentation:
94
+
95
+ ## Step 1 — Component Identification
96
+
97
+ List:
98
+
99
+ - All major architectural components
100
+ - All layers
101
+ - External integrations
102
+ - Cross-cutting concerns
103
+
104
+ Ensure no component left undocumented.
105
+
106
+ ---
107
+
108
+ ## Step 2 — Documentation Map Creation
109
+
110
+ Plan structure:
111
+
112
+ ```
113
+
114
+ 06_Documentation/
115
+
116
+ ├── SYSTEM_OVERVIEW.md
117
+ ├── ARCHITECTURE.md
118
+
119
+ ├── COMPONENT_/
120
+ │ ├── OVERVIEW.md
121
+ │ ├── DATA_FLOW.md
122
+ │ ├── FAILURE_MODEL.md
123
+ │ ├── SECURITY_MODEL.md
124
+ │ └── INTERNAL_STRUCTURE.md
125
+
126
+ ```
127
+
128
+ Each component must be uniquely documented.
129
+ No duplicate templates allowed.
130
+
131
+ ---
132
+
133
+ # 6️⃣ Structured Documentation Execution
134
+
135
+ ---
136
+
137
+ ## Phase A — System Overview Documentation
138
+
139
+ Must include:
140
+
141
+ - Problem explanation (simple)
142
+ - System role
143
+ - High-level architecture
144
+ - Technology stack
145
+ - ASCII system diagram
146
+ - Mermaid C4 diagram
147
+ - Scaling explanation
148
+ - Security boundary overview
149
+ - Failure overview
150
+
151
+ Beginner-friendly explanation required.
152
+
153
+ ---
154
+
155
+ ## Phase B — Architecture Documentation
156
+
157
+ Must include:
158
+
159
+ - Folder structure (ASCII)
160
+ - Component responsibility mapping
161
+ - Data flow diagrams
162
+ - Sequence diagrams
163
+ - Failure model summary
164
+ - Security model summary
165
+ - Observability explanation
166
+ - Deployment topology overview
167
+
168
+ Diagrams mandatory.
169
+
170
+ ---
171
+
172
+ ## Phase C — Component-Level Documentation
173
+
174
+ For EACH component:
175
+
176
+ Generate:
177
+
178
+ ### 1. OVERVIEW.md
179
+
180
+ - Purpose
181
+ - Responsibility
182
+ - What it does NOT do
183
+ - Interaction boundaries
184
+ - Beginner explanation
185
+
186
+ ### 2. DATA_FLOW.md
187
+
188
+ - Mermaid sequence diagram
189
+ - ASCII flow diagram
190
+ - Step-by-step explanation
191
+
192
+ ### 3. FAILURE_MODEL.md
193
+
194
+ - Failure cases
195
+ - Retry logic
196
+ - Timeout logic
197
+ - Error propagation
198
+ - Circuit breaker (if exists)
199
+
200
+ ### 4. SECURITY_MODEL.md
201
+
202
+ - Auth boundaries
203
+ - Authorization
204
+ - Input validation
205
+ - Data sensitivity
206
+
207
+ ### 5. INTERNAL_STRUCTURE.md
208
+
209
+ - Class/module structure
210
+ - Dependency direction
211
+ - Internal diagrams
212
+ - Why structured that way
213
+
214
+ No component documentation may be shallow.
215
+
216
+ ---
217
+
218
+ # 7️⃣ Diagram Enforcement Rules
219
+
220
+ Each of these must include diagrams:
221
+
222
+ - System Overview → 1 Mermaid + 1 ASCII
223
+ - Architecture → 2+ Mermaid + ASCII folder tree
224
+ - Each Component → At least 1 Mermaid + 1 ASCII
225
+
226
+ No placeholder diagrams allowed.
227
+
228
+ Diagrams must reflect actual architecture.
229
+
230
+ ---
231
+
232
+ # 8️⃣ Beginner Accessibility Layer
233
+
234
+ Each major documentation file must include:
235
+
236
+ Section titled:
237
+
238
+ "🧒 If you're new"
239
+
240
+ Explain:
241
+
242
+ - Core concept simply
243
+ - Real-world analogy
244
+ - Plain English explanation
245
+
246
+ Documentation must be understandable to:
247
+
248
+ - New developer
249
+ - Junior engineer
250
+ - Technical intern
251
+
252
+ Without losing accuracy.
253
+
254
+ ---
255
+
256
+ # 9️⃣ Consistency Validation Gate
257
+
258
+ Before completion:
259
+
260
+ Validate:
261
+
262
+ - Component names match architecture
263
+ - Folder names match actual repo
264
+ - Technology stack matches architecture
265
+ - No outdated terminology
266
+ - No drift from PRD
267
+ - Diagrams reflect current system
268
+
269
+ If drift detected:
270
+ → Escalate to Architect.
271
+
272
+ ---
273
+
274
+ # 🔟 Quality Checklist (MANDATORY BEFORE PHASE CLOSE)
275
+
276
+ - [ ] System overview complete
277
+ - [ ] Architecture explanation complete
278
+ - [ ] All components documented
279
+ - [ ] Failure model explained
280
+ - [ ] Security model explained
281
+ - [ ] Folder structure documented
282
+ - [ ] Mermaid diagrams included
283
+ - [ ] ASCII diagrams included
284
+ - [ ] Beginner explanation included
285
+ - [ ] No copy-paste repetition
286
+ - [ ] Terminology consistent
287
+
288
+ If any unchecked → Phase incomplete.
289
+
290
+ ---
291
+
292
+ # 1️⃣1️⃣ State Update Protocol
293
+
294
+ After documentation generation:
295
+
296
+ 1. Update PROJECT_STATE.md:
297
+ - Documentation Phase → Completed
298
+ 2. Append entry in PROGRESS_LOG.md:
299
+ - Date
300
+ - Components documented
301
+ 3. If new drift discovered:
302
+ - Log issue
303
+ - Escalate
304
+
305
+ ---
306
+
307
+ # 1️⃣2️⃣ Resume Logic
308
+
309
+ If documentation phase interrupted:
310
+
311
+ Resume by:
312
+
313
+ - Checking which components documented
314
+ - Verifying consistency
315
+ - Continuing missing components
316
+ - Re-validating diagrams
317
+
318
+ Do NOT regenerate everything blindly.
319
+
320
+ ---
321
+
322
+ # 1️⃣3️⃣ Anti-Patterns to Avoid
323
+
324
+ - Copying architecture file verbatim
325
+ - Generic explanations
326
+ - No diagrams
327
+ - Ignoring failure model
328
+ - Ignoring security model
329
+ - Repeating same template blindly
330
+ - Writing marketing-style text
331
+ - Overly technical without beginner layer
332
+
333
+ ---
334
+
335
+ # 1️⃣4️⃣ Success Criteria
336
+
337
+ Documentation is considered enterprise-grade when:
338
+
339
+ - New developer can onboard without code reading
340
+ - Architecture is visually understandable
341
+ - Component responsibilities are clear
342
+ - Failure paths explained
343
+ - Security boundaries explicit
344
+ - Diagrams accurate
345
+ - Folder structure justified
346
+ - No ambiguity remains
347
+
348
+ Documentation reduces onboarding time.
349
+ Documentation reduces architecture drift.
350
+ Documentation increases system clarity.
351
+
352
+ You are building clarity infrastructure.
@@ -0,0 +1,106 @@
1
+
2
+ # 🧠 Idea Refinement Workflow (Concept Discipline Layer)
3
+
4
+ ---
5
+
6
+ # Phase Objective
7
+
8
+ Transform raw idea into structured, bounded, risk-aware conceptual document.
9
+
10
+ ---
11
+
12
+ # Entry Preconditions
13
+
14
+ - Raw idea provided
15
+ - No active upstream contradictions
16
+ - PROJECT_STATE allows idea phase
17
+
18
+ ---
19
+
20
+ # Required Artifact
21
+
22
+ 03_Project_Info/Idea_Analyst/IDEA.md
23
+
24
+ ---
25
+
26
+ # Structured Execution
27
+
28
+ ## Step 1: Input Clarity Scan
29
+
30
+ - Identify vague terms
31
+ - Identify missing actors
32
+ - Identify missing constraints
33
+ - Identify hidden assumptions
34
+
35
+ If unclear → ask clarifying questions.
36
+
37
+ ---
38
+
39
+ ## Step 2: Problem Precision
40
+
41
+ Define:
42
+
43
+ - Who suffers?
44
+ - What pain?
45
+ - Why now?
46
+ - What happens if not solved?
47
+
48
+ ---
49
+
50
+ ## Step 3: Assumption Extraction
51
+
52
+ List:
53
+
54
+ - Technical assumptions
55
+ - User behavior assumptions
56
+ - Resource assumptions
57
+
58
+ ---
59
+
60
+ ## Step 4: Scope Bounding
61
+
62
+ Define:
63
+
64
+ - In Scope
65
+ - Out of Scope
66
+ - MVP boundary
67
+
68
+ ---
69
+
70
+ ## Step 5: Risk Exposure
71
+
72
+ Surface:
73
+
74
+ - Feasibility risk
75
+ - Adoption risk
76
+ - Resource risk
77
+
78
+ ---
79
+
80
+ # Exit Validation
81
+
82
+ - [ ] Problem defined
83
+ - [ ] Scope bounded
84
+ - [ ] Risks listed
85
+ - [ ] Assumptions documented
86
+ - [ ] No architecture references
87
+
88
+ ---
89
+
90
+ # Escalation Matrix
91
+
92
+ | Issue | Escalate To |
93
+ | ----------------------- | ---------------- |
94
+ | Business contradiction | Business Analyst |
95
+ | Technical impossibility | Flag explicitly |
96
+
97
+ ---
98
+
99
+ # State Update
100
+
101
+ Update:
102
+
103
+ - PROJECT_STATE.md
104
+ - PROGRESS_LOG.md
105
+
106
+ Recommend Business Analysis.
@@ -0,0 +1,29 @@
1
+
2
+ # ⚡ Performance Review Workflow
3
+
4
+ ---
5
+
6
+ # Entry Preconditions
7
+
8
+ - Security review complete
9
+
10
+ ---
11
+
12
+ # Structured Execution
13
+
14
+ ## Step 1: Target validation
15
+
16
+ ## Step 2: Bottleneck scan
17
+
18
+ ## Step 3: DB efficiency check
19
+
20
+ ## Step 4: Load simulation
21
+
22
+ ## Step 5: Risk classification
23
+
24
+ ---
25
+
26
+ # Exit Validation
27
+
28
+ - [ ] Bottlenecks identified
29
+ - [ ] Optimization suggestions documented
@@ -0,0 +1,83 @@
1
+ # 📌 PRD Generation Workflow (Requirements Enforcement Layer)
2
+
3
+ ---
4
+
5
+ # Phase Objective
6
+
7
+ Produce measurable, testable, architecture-consumable PRD.
8
+
9
+ ---
10
+
11
+ # Entry Preconditions
12
+
13
+ - IDEA.md exists
14
+ - Business viability assessed
15
+ - No unresolved conceptual contradictions
16
+
17
+ ---
18
+
19
+ # Required Artifact
20
+
21
+ 03_Project_Info/Product_Manager/PRD.md
22
+
23
+ ---
24
+
25
+ # Structured Execution
26
+
27
+ ## Step 1: Scope Lock
28
+
29
+ Define MVP explicitly before FR writing.
30
+
31
+ ## Step 2: Goal Formalization
32
+
33
+ Convert all goals to measurable statements.
34
+
35
+ ## Step 3: Persona Structuring
36
+
37
+ Detailed personas only.
38
+
39
+ ## Step 4: Use Case Modeling
40
+
41
+ Include:
42
+
43
+ - Failure flows
44
+ - Alternate flows
45
+
46
+ ## Step 5: FR Authoring
47
+
48
+ Rules:
49
+
50
+ - Atomic
51
+ - Measurable
52
+ - Traceable to use case
53
+
54
+ ## Step 6: NFR Definition
55
+
56
+ Must define:
57
+
58
+ - Performance targets
59
+ - Reliability targets
60
+ - Security baseline
61
+ - Scalability expectations
62
+
63
+ ---
64
+
65
+ # Exit Validation
66
+
67
+ - [ ] All FR atomic
68
+ - [ ] NFR measurable
69
+ - [ ] Non-goals listed
70
+ - [ ] No tech stack references
71
+
72
+ ---
73
+
74
+ # Escalation
75
+
76
+ PRD contradiction → Idea_Analyst
77
+ Unrealistic goal → Business_Analyst
78
+
79
+ ---
80
+
81
+ # State Update
82
+
83
+ Recommend Architect.
@@ -0,0 +1,35 @@
1
+
2
+ # 🔁 Refactor Workflow (Tech Debt Discipline)
3
+
4
+ ---
5
+
6
+ # Phase Objective
7
+
8
+ Improve structure without behavioral change.
9
+
10
+ ---
11
+
12
+ # Entry Preconditions
13
+
14
+ - Testing green
15
+ - No active feature tasks
16
+
17
+ ---
18
+
19
+ # Structured Execution
20
+
21
+ ## Step 1: Identify complexity hotspots
22
+
23
+ ## Step 2: Ensure no behavior change
24
+
25
+ ## Step 3: Maintain test coverage
26
+
27
+ ## Step 4: Improve modularity
28
+
29
+ ---
30
+
31
+ # Exit Validation
32
+
33
+ - [ ] No functionality changed
34
+ - [ ] Tests still passing
35
+ - [ ] Complexity reduced
@@ -0,0 +1,30 @@
1
+
2
+ # 🔐 Security Audit Workflow (Threat Enforcement)
3
+
4
+ ---
5
+
6
+ # Entry Preconditions
7
+
8
+ - Architecture complete
9
+ - Implementation complete
10
+
11
+ ---
12
+
13
+ # Structured Execution
14
+
15
+ ## Step 1: Asset identification
16
+
17
+ ## Step 2: Threat modeling
18
+
19
+ ## Step 3: Code surface scan
20
+
21
+ ## Step 4: OWASP alignment
22
+
23
+ ## Step 5: Risk classification
24
+
25
+ ---
26
+
27
+ # Exit Validation
28
+
29
+ - [ ] Threat model defined
30
+ - [ ] Vulnerabilities classified
@@ -0,0 +1,33 @@
1
+
2
+ # ⚙ Task Execution Workflow (Implementation Discipline)
3
+
4
+ ---
5
+
6
+ # Entry Preconditions
7
+
8
+ - TASK_PLAN exists
9
+ - Dependencies satisfied
10
+
11
+ ---
12
+
13
+ # Structured Execution
14
+
15
+ ## Step 1: Review task file
16
+
17
+ ## Step 2: Validate dependencies
18
+
19
+ ## Step 3: Implement strictly within scope
20
+
21
+ ## Step 4: Validate acceptance criteria
22
+
23
+ ## Step 5: Update checklist
24
+
25
+ ## Step 6: Update state
26
+
27
+ ---
28
+
29
+ # Anti-Patterns
30
+
31
+ - Multi-task implementation
32
+ - Architecture modification
33
+ - Checklist skipping
@@ -0,0 +1,61 @@
1
+
2
+ # 🧩 Task Generation Workflow (Execution Blueprint Layer)
3
+
4
+ ---
5
+
6
+ # Phase Objective
7
+
8
+ Convert architecture into atomic, dependency-aware tasks.
9
+
10
+ ---
11
+
12
+ # Entry Preconditions
13
+
14
+ - ARCHITECTURE.md complete
15
+
16
+ ---
17
+
18
+ # Required Artifacts
19
+
20
+ 04_Tasks/TASK_PLAN.md
21
+ 04_Tasks/DEVELOPMENT_CHECKLIST.md
22
+ 04_Tasks/TASKS/*.md
23
+
24
+ ---
25
+
26
+ # Structured Execution
27
+
28
+ ## Step 1: Architecture Decomposition
29
+
30
+ Break into layers.
31
+
32
+ ## Step 2: Task Atomization
33
+
34
+ Each task must:
35
+
36
+ - Single responsibility
37
+ - Acceptance criteria
38
+ - Hard/Soft dependencies
39
+ - Complexity tag
40
+
41
+ ## Step 3: Dependency Graph
42
+
43
+ Generate Mermaid graph.
44
+
45
+ ## Step 4: Critical Path Marking
46
+
47
+ Mark 🔴 tasks.
48
+
49
+ ---
50
+
51
+ # Exit Validation
52
+
53
+ - [ ] All components mapped
54
+ - [ ] No circular dependencies
55
+ - [ ] All tasks atomic
56
+
57
+ ---
58
+
59
+ # State Update
60
+
61
+ Recommend Task Execution.