template-instructions 1.0.1 → 1.1.1

package/README.md

@@ -44,20 +44,54 @@ Instead of one "generic" AI trying to do everything, you get specialized experts
 -   Optimized for iterative development.
 -   Keeps files organized by Sprint (`docs/sprints/sprint-X/`), preventing clutter and ensuring version control.
 
+## � Installation
+
+### Prerequisites
+- Node.js (version 14 or higher)
+- npm or yarn
+
+### Install the CLI Tool
+```bash
+npm install -g template-instructions
+```
+
+### Create a New Project with Instructions
+```bash
+create-instructions my-sdlc-project
+```
+
+This will create a new folder `my-sdlc-project` containing all the instruction files and templates.
+
+### Manual Setup
+Alternatively, clone this repository and copy the `instructions/` folder to your desired location.
+
+## 🔧 Setup with Gemini
+
+1. Copy the instruction files to your Gemini workspace:
+   ```bash
+   cp -r instructions/ ~/.gemini/instructions/
+   ```
+   (Or manually copy the `instructions/` folder to `.gemini/instructions/` in your project.)
+
+2. Ensure your Gemini configuration points to this instructions directory.
+
 ## 📁 Repository Structure
 
 ```
 .
+├── bin/
+│   └── cli.js                      # CLI tool for scaffolding new projects
 ├── instructions/
-│   ├── global.md                    # Mandatory global rules and SDLC workflows
-│   ├── usage.md                     # Detailed usage guide and examples
-│   ├── roles/                       # Role-specific instruction definitions
-│   │   ├── pm.md, po.md, sa.md...   # (PM, PO, SA, UIUX, QA, etc.)
-│   └── templates/                   # Standardized document templates
+│   ├── global.md                   # Mandatory global rules and SDLC workflows
+│   ├── usage.md                    # Detailed usage guide and examples
+│   ├── roles/                      # Role-specific instruction definitions
+│   │   ├── pm.md, po.md, sa.md...  # (PM, PO, SA, UIUX, QA, etc.)
+│   └── templates/                  # Standardized document templates
 │       ├── Project-Plan-Template.md
 │       ├── Product-Backlog-Template.md
 │       └── ...
-└── README.md                        # This file
+├── package.json                    # Project metadata and scripts
+└── README.md                       # This file
 ```
 
 ## 🚀 Quick Start

package/bin/cli.js

@@ -7,7 +7,7 @@ import { fileURLToPath } from 'url';
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const projectName = process.argv[2] || 'my-new-project';
 const targetPath = path.join(process.cwd(), projectName);
-const templatePath = path.join(__dirname, '../.instructions'); // Folder containing your template files
+const templatePath = path.join(__dirname, '../instructions'); // Folder containing your template files
 
 async function scaffold() {
   try {

package/instructions/global.md

@@ -194,8 +194,14 @@ Handled by REPORTER or STAKEHOLDER when:
 - Use screenshots, recordings, or browser artifacts for proof
 - All agents must produce verifiable artifacts (logs, reports, diagrams)
 
-### 9. Completion Criteria
-Project is complete ONLY when:
+### 10. Mandatory Reporting
+After completing any task or phase, the role **MUST** create the corresponding report file as specified in the Artifact Naming Convention. This ensures full traceability and audit trail.
+
+- **No task is considered complete without its artifact.**
+- Artifacts must be placed in the exact folder structure: `docs/sprints/sprint-[N]/[category]/`
+- Use version numbers (v1, v2, etc.) for revisions.
+
+### 11. Completion Criteria
 - ✅ STAKEHOLDER approves
 - ✅ No critical/high bugs remain
 - ✅ All Must-Have features delivered and verified

package/instructions/usage.md

@@ -178,6 +178,7 @@ Artifacts are organized by type in the `docs/` folder:
 - Provide clear approval before phase transitions
 - Use correct tags to invoke roles
 - Review generated artifacts
+- **Create and save the required report file after completing any task**
 
 ### ❌ DON'T:
 - Skip phases (e.g., coding before design approval)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "template-instructions",
-  "version": "1.0.1",
+  "version": "1.1.1",
   "description": "Simulating a complete Software Development Lifecycle (SDLC) with specialized AI Agents.",
   "main": "index.js",
   "bin": {