template-instructions 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.
@@ -0,0 +1,209 @@
1
+ # 📚 TeamLifecycle Instructions - Usage Guide
2
+
3
+ > **Version:** 1.0
4
+ > **Last Updated:** 2025-12-23
5
+
6
+ ---
7
+
8
+ ## 🎯 Overview
9
+
10
+ This instruction set simulates a **complete Software Development Lifecycle (SDLC)** with specialized roles. When you invoke a role using `@tag`, Gemini will act as that role and perform tasks according to the defined workflow.
11
+
12
+ ---
13
+
14
+ ## 📁 Directory Structure
15
+
16
+ ```
17
+ .gemini/instructions/
18
+ ├── global.md # Global rules (mandatory)
19
+ ├── roles/ # Team roles
20
+ │ ├── pm.md # Project Manager
21
+ │ ├── po.md # Product Owner
22
+ │ ├── sa.md # Solution Architect
23
+ │ ├── designer.md # UI/UX Designer
24
+ │ ├── qa.md # Quality Assurance
25
+ │ ├── seca.md # Security Analyst
26
+ │ ├── dev.md # Developer
27
+ │ ├── devops.md # DevOps Engineer
28
+ │ ├── tester.md # Tester
29
+ │ ├── reporter.md # Reporter
30
+ │ └── stakeholder.md # Stakeholder
31
+ └── templates/ # Document templates
32
+ ├── Project-Plan-Template.md
33
+ ├── Product-Backlog-Template.md
34
+ ├── Backend-Design-Spec-Template.md
35
+ ├── Design-Verification-Report-Template.md
36
+ ├── Security-Review-Report-Template.md
37
+ ├── Development-Log-Template.md
38
+ ├── DevOps-Plan-Template.md
39
+ ├── Test-Report-Template.md
40
+ ├── Phase-Report-Template.md
41
+ ├── Final-Approval-Report-Template.md
42
+ ├── definition-of-done.md
43
+ └── incident-response.md
44
+ ```
45
+
46
+ ---
47
+
48
+ ## 🚀 Getting Started
49
+
50
+ ### Step 1: Start a Project
51
+
52
+ Invoke **PM** to begin planning:
53
+
54
+ ```
55
+ @PM - I want to build a wedding website with:
56
+ - Couple introduction page
57
+ - Countdown timer
58
+ - Photo gallery
59
+ - RSVP form
60
+ ```
61
+
62
+ PM will create `Project-Plan-v1.md` and wait for your approval.
63
+
64
+ ### Step 2: Approval
65
+
66
+ After reviewing the plan, respond with:
67
+ - ✅ **"Approved"** - Proceed to next phase
68
+ - 🔄 **Provide feedback** - PM will revise and create a new version
69
+
70
+ ### Step 3: Automatic Workflow
71
+
72
+ Once approved, roles are triggered automatically in sequence:
73
+
74
+ ```
75
+ PM → SA + UIUX + PO → QA + SecA → DEV + DevOps → TESTER → REPORTER → STAKEHOLDER
76
+ ```
77
+
78
+ ---
79
+
80
+ ## 📋 Roles & Tags
81
+
82
+ | Role | Tag | Responsibility |
83
+ |------|-----|----------------|
84
+ | **Project Manager** | `@PM` | Planning, scope management, team coordination |
85
+ | **Product Owner** | `@PO` | Backlog management, feature prioritization |
86
+ | **Solution Architect** | `@SA` | Backend architecture, database, API design |
87
+ | **UI/UX Designer** | `@UIUX` | Interface design, user experience |
88
+ | **QA Analyst** | `@QA` | Design review, quality assurance |
89
+ | **Security Analyst** | `@SECA` | Security assessment |
90
+ | **Developer** | `@DEV` | Code implementation |
91
+ | **DevOps** | `@DEVOPS` | CI/CD, deployment, infrastructure |
92
+ | **Tester** | `@TESTER` | Functional testing, bug detection |
93
+ | **Reporter** | `@REPORTER` | Progress reports, documentation |
94
+ | **Stakeholder** | `@STAKEHOLDER` | Final approval |
95
+
96
+ ---
97
+
98
+ ## 🏷️ Important Tags
99
+
100
+ ### Phase Tags
101
+ | Tag | Description |
102
+ |-----|-------------|
103
+ | `#planning` | Planning phase |
104
+ | `#designing` | Design phase |
105
+ | `#development` | Development phase |
106
+ | `#testing` | Testing phase |
107
+ | `#reporting` | Reporting phase |
108
+
109
+ ### Bug Priority Tags
110
+ | Tag | Severity |
111
+ |-----|----------|
112
+ | `#fixbug-critical` | Breaks core functionality |
113
+ | `#fixbug-high` | Major feature broken |
114
+ | `#fixbug-medium` | Works but incorrect behavior |
115
+ | `#fixbug-low` | Cosmetic issues |
116
+
117
+ ### Special Tags
118
+ | Tag | Description |
119
+ |-----|-------------|
120
+ | `#blocked` | Blocked, needs support |
121
+ | `#hotfix` | Emergency fix |
122
+ | `#rollback` | Needs rollback |
123
+ | `#deployed-staging` | Deployed to staging |
124
+ | `#deployed-production` | Deployed to production |
125
+
126
+ ---
127
+
128
+ ## 📄 Generated Artifacts
129
+
130
+ Artifacts are organized by type in the `docs/` folder:
131
+
132
+ | Folder | Artifacts | Owner |
133
+ |--------|-----------|-------|
134
+ | `docs/plans/` | Project-Plan-v*.md, Product-Backlog-v*.md | PM, PO |
135
+ | `docs/designs/` | Backend-Design-Spec-v*.md, UIUX-Design-Spec-v*.md | SA, UIUX |
136
+ | `docs/reviews/` | Design-Verification-Report-v*.md, Security-Review-Report-v*.md | QA, SecA |
137
+ | `docs/logs/` | Development-Log-v*.md, DevOps-Plan-and-Log-v*.md | DEV, DevOps |
138
+ | `docs/tests/` | Test-Report-v*.md | TESTER |
139
+ | `docs/reports/` | Phase-Report-*.md, Final-Project-Report.md, Final-Approval-Report.md | REPORTER, STAKEHOLDER |
140
+
141
+ > ⚠️ **CRITICAL:** All artifacts are in `docs/`, NEVER in `.gemini/`
142
+
143
+ ---
144
+
145
+ ## 💡 Usage Examples
146
+
147
+ ### Request new design
148
+ ```
149
+ @UIUX - Design a gallery page with lightbox effect
150
+ ```
151
+
152
+ ### Request bug fix
153
+ ```
154
+ @DEV - Fix BUG-001: Countdown not displaying correctly on mobile
155
+ ```
156
+
157
+ ### Request security review
158
+ ```
159
+ @SECA - Review RSVP form for XSS vulnerabilities
160
+ ```
161
+
162
+ ### Check progress
163
+ ```
164
+ @REPORTER - Summarize current project progress
165
+ ```
166
+
167
+ ### Request deployment
168
+ ```
169
+ @DEVOPS - Deploy current version to staging
170
+ ```
171
+
172
+ ---
173
+
174
+ ## ⚠️ Important Rules
175
+
176
+ ### ✅ DO:
177
+ - Start with `@PM` for new projects
178
+ - Provide clear approval before phase transitions
179
+ - Use correct tags to invoke roles
180
+ - Review generated artifacts
181
+
182
+ ### ❌ DON'T:
183
+ - Skip phases (e.g., coding before design approval)
184
+ - Add features not in approved plan
185
+ - Bypass security review
186
+
187
+ ---
188
+
189
+ ## 🔄 Changing Scope
190
+
191
+ 1. Invoke `@PM` with change request
192
+ 2. PM creates new plan version
193
+ 3. Wait for re-approval
194
+ 4. Continue workflow
195
+
196
+ ---
197
+
198
+ ## 📞 Need Help?
199
+
200
+ If unsure which role to invoke:
201
+ ```
202
+ @PM - I need help with [describe issue], who should I contact?
203
+ ```
204
+
205
+ PM will direct you to the right person.
206
+
207
+ ---
208
+
209
+ #instructions #usage-guide
package/package.json ADDED
@@ -0,0 +1,13 @@
1
+ {
2
+ "name": "template-instructions",
3
+ "version": "1.0.0",
4
+ "description": "CLI to scaffold clean architecture projects",
5
+ "main": "index.js",
6
+ "bin": {
7
+ "create-instructions": "./bin/cli.js"
8
+ },
9
+ "scripts": {
10
+ "test": "echo \"Error: no test specified\" && exit 1"
11
+ },
12
+ "type": "module"
13
+ }