@hanzlaa/rcode 3.6.16 → 4.0.0

package/rcode/skills/actions/2-plan/rcode-create-ux-design/workflow.md

@@ -0,0 +1,36 @@
+# Create UX Design Workflow
+
+**Goal:** Create comprehensive UX design specifications through collaborative visual exploration and informed decision-making where you act as a UX facilitator working with a product stakeholder.
+
+---
+
+## WORKFLOW ARCHITECTURE
+
+This uses **micro-file architecture** for disciplined execution:
+
+- Each step is a self-contained file with embedded rules
+- Sequential progression with user control at each step
+- Document state tracked in frontmatter
+- Append-only document building through conversation
+
+---
+
+## INITIALIZATION
+
+### Configuration Loading
+
+Load config from `{project-root}/.rcode/config.json` and resolve:
+
+- `project_name`, `output_folder`, `planning_artifacts`, `user_name`
+- `communication_language`, `document_output_language`, `user_skill_level`
+- `date` as system-generated current datetime
+
+### Paths
+
+- `default_output_file` = `{planning_artifacts}/ux-design-specification.md`
+
+## EXECUTION
+
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+- ✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`
+- Read fully and follow: `./steps/step-01-init.md` to begin the UX design workflow.

package/rcode/skills/actions/2-plan/rcode-edit-prd/SKILL.md

@@ -0,0 +1,45 @@
+---
+name: rcode-edit-prd
+internal: true
+description: >
+  Update an existing Product Requirements Document with new sections,
+  revisions, or clarifications. Activates when the user says "update the
+  PRD", "edit the PRD", "add a section to the PRD", "revise requirements",
+  or "change the scope in the PRD". Do NOT use to create a new PRD (use
+  rcode-create-prd) or to validate quality (use rcode-validate-prd).
+triggers:
+  - "update the
+  PRD"
+  - "edit the PRD"
+  - "add a section to the PRD"
+  - "revise requirements"
+  - "change the scope in the PRD"
+user-invocable: true
+---
+@.rcode/references/karpathy-guidelines.md
+
+
+## Overview
+
+Update an existing Product Requirements Document with new sections, revisions, or clarifications.
+
+## Workflow
+
+Follow the instructions in ./workflow.md.
+
+## Output Format
+
+- Preserves existing PRD structure; only modifies requested sections
+- Every change logged with date and reason
+- Do NOT rewrite sections that weren't asked to change
+- Do NOT introduce new structure inconsistent with the rest of the PRD
+
+## Examples
+
+### Happy Path
+**Input:** "Update the PRD to remove the analytics feature from v1 scope"
+**Expected behavior:** Locate PRD, find analytics section, move to "Out of Scope (v2)", add change log entry, save.
+
+### Edge Case: Conflicting Updates
+**Input:** "Remove analytics" — but another section still references it
+**Expected behavior:** Scan for references first. Report: "Analytics is also referenced in Section 4.2 and Metrics. Should I remove those too, or keep as related context?" Do NOT silently leave dangling references.

package/rcode/skills/actions/2-plan/rcode-edit-prd/steps-e/step-e-01-discovery.md

@@ -0,0 +1,242 @@
+---
+# File references (ONLY variables used in this step)
+prdPurpose: '{project-root}/_rcode-skills/2-plan-workflows/create-prd/data/prd-purpose.md'
+---
+
+# Step E-1: Discovery & Understanding
+
+## STEP GOAL:
+
+Understand what the user wants to edit in the PRD, detect PRD format/type, check for validation report guidance, and route appropriately.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 NEVER generate content without user input
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
+- 📋 YOU ARE A FACILITATOR, not a content generator
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+- ✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`
+
+### Role Reinforcement:
+
+- ✅ You are a Validation Architect and PRD Improvement Specialist
+- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role
+- ✅ We engage in collaborative dialogue, not command-response
+- ✅ You bring analytical expertise and improvement guidance
+- ✅ User brings domain knowledge and edit requirements
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on discovering user intent and PRD format
+- 🚫 FORBIDDEN to make any edits yet
+- 💬 Approach: Inquisitive and analytical, understanding before acting
+- 🚪 This is a branch step - may route to legacy conversion
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Discover user's edit requirements
+- 🎯 Auto-detect validation reports in PRD folder (use as guide)
+- 🎯 Load validation report if provided (use as guide)
+- 🎯 Detect PRD format (rcode/legacy)
+- 🎯 Route appropriately based on format
+- 💾 Document discoveries for next step
+- 🚫 FORBIDDEN to proceed without understanding requirements
+
+## CONTEXT BOUNDARIES:
+
+- Available context: PRD file to edit, optional validation report, auto-detected validation reports
+- Focus: User intent discovery and format detection only
+- Limits: Don't edit yet, don't validate yet
+- Dependencies: None - this is first edit step
+
+## MANDATORY SEQUENCE
+
+**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change.
+
+### 1. Load PRD Purpose Standards
+
+Load and read the complete file at:
+`{prdPurpose}` (data/prd-purpose.md)
+
+This file defines what makes a great rcode PRD. Internalize this understanding - it will guide improvement recommendations.
+
+### 2. Discover PRD to Edit
+
+"**PRD Edit Workflow**
+
+Which PRD would you like to edit?
+
+Please provide the path to the PRD file you want to edit."
+
+**Wait for user to provide PRD path.**
+
+### 3. Validate PRD Exists and Load
+
+Once PRD path is provided:
+- Check if PRD file exists at specified path
+- If not found: "I cannot find a PRD at that path. Please check the path and try again."
+- If found: Load the complete PRD file including frontmatter
+
+### 4. Check for Existing Validation Report
+
+**Check if validation report exists in the PRD folder:**
+
+```bash
+# Look for most recent validation report in the PRD folder
+ls -t {prd_folder_path}/validation-report-*.md 2>/dev/null | head -1
+```
+
+**If validation report found:**
+
+Display:
+"**📋 Found Validation Report**
+
+I found a validation report from {validation_date} in the PRD folder.
+
+This report contains findings from previous validation checks and can help guide our edits to fix known issues.
+
+**Would you like to:**
+- **[U] Use validation report** - Load it to guide and prioritize edits
+- **[S] Skip** - Proceed with manual edit discovery"
+
+**Wait for user input.**
+
+**IF U (Use validation report):**
+- Load the validation report file
+- Extract findings, issues, and improvement suggestions
+- Note: "Validation report loaded - will use it to guide prioritized improvements"
+- Continue to step 5
+
+**IF S (Skip) or no validation report found:**
+- Note: "Proceeding with manual edit discovery"
+- Continue to step 5
+
+**If no validation report found:**
+- Note: "No validation report found in PRD folder"
+- Continue to step 5 without asking user
+
+### 5. Ask About Validation Report
+
+"**Do you have a validation report to guide edits?**
+
+If you've run the validation workflow on this PRD, I can use that report to guide improvements and prioritize changes.
+
+Validation report path (or type 'none'):"
+
+**Wait for user input.**
+
+**If validation report path provided:**
+- Load the validation report
+- Extract findings, severity, improvement suggestions
+- Note: "Validation report loaded - will use it to guide prioritized improvements"
+
+**If no validation report:**
+- Note: "Proceeding with manual edit discovery"
+- Continue to step 6
+
+### 6. Discover Edit Requirements
+
+"**What would you like to edit in this PRD?**
+
+Please describe the changes you want to make. For example:
+- Fix specific issues (information density, implementation leakage, etc.)
+- Add missing sections or content
+- Improve structure and flow
+- Convert to rcode format (if legacy PRD)
+- General improvements
+- Other changes
+
+**Describe your edit goals:**"
+
+**Wait for user to describe their requirements.**
+
+### 7. Detect PRD Format
+
+Analyze the loaded PRD:
+
+**Extract all ## Level 2 headers** from PRD
+
+**Check for rcode PRD core sections:**
+1. Executive Summary
+2. Success Criteria
+3. Product Scope
+4. User Journeys
+5. Functional Requirements
+6. Non-Functional Requirements
+
+**Classify format:**
+- **rcode Standard:** 5-6 core sections present
+- **rcode Variant:** 3-4 core sections present, generally follows rcode patterns
+- **Legacy (Non-Standard):** Fewer than 3 core sections, does not follow rcode structure
+
+### 8. Route Based on Format and Context
+
+**IF validation report provided OR PRD is rcode Standard/Variant:**
+
+Display: "**Edit Requirements Understood**
+
+**PRD Format:** {classification}
+{If validation report: "**Validation Guide:** Yes - will use validation report findings"}
+**Edit Goals:** {summary of user's requirements}
+
+**Proceeding to deep review and analysis...**"
+
+Read fully and follow: `./step-e-02-review.md`
+
+**IF PRD is Legacy (Non-Standard) AND no validation report:**
+
+Display: "**Format Detected:** Legacy PRD
+
+This PRD does not follow rcode standard structure (only {count}/6 core sections present).
+
+**Your edit goals:** {user's requirements}
+
+**How would you like to proceed?**"
+
+Present MENU OPTIONS below for user selection
+
+### 9. Present MENU OPTIONS (Legacy PRDs Only)
+
+**[C] Convert to rcode Format** - Convert PRD to rcode standard structure, then apply your edits
+**[E] Edit As-Is** - Apply your edits without converting the format
+**[X] Exit** - Exit and review conversion options
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input
+- Only proceed based on user selection
+
+#### Menu Handling Logic:
+
+- IF C (Convert): Read fully and follow: `./step-e-01b-legacy-conversion.md`
+- IF E (Edit As-Is): Display "Proceeding with edits..." then load next step
+- IF X (Exit): Display summary and exit
+- IF Any other: help user, then redisplay menu
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- User's edit requirements clearly understood
+- Auto-detected validation reports loaded and analyzed (when found)
+- Manual validation report loaded and analyzed (if provided)
+- PRD format detected correctly
+- rcode PRDs proceed directly to review step
+- Legacy PRDs pause and present conversion options
+- User can choose conversion path or edit as-is
+
+### ❌ SYSTEM FAILURE:
+
+- Not discovering user's edit requirements
+- Not auto-detecting validation reports in PRD folder
+- Not loading validation report when provided (auto or manual)
+- Missing format detection
+- Not pausing for legacy PRDs without guidance
+- Auto-proceeding without understanding intent
+
+**Master Rule:** Understand before editing. Detect format early so we can guide users appropriately. Auto-detect and use validation reports for prioritized improvements.

package/rcode/skills/actions/2-plan/rcode-edit-prd/steps-e/step-e-01b-legacy-conversion.md

@@ -0,0 +1,204 @@
+---
+# File references (ONLY variables used in this step)
+prdFile: '{prd_file_path}'
+prdPurpose: '{project-root}/_rcode-skills/2-plan-workflows/create-prd/data/prd-purpose.md'
+---
+
+# Step E-1B: Legacy PRD Conversion Assessment
+
+## STEP GOAL:
+
+Analyze legacy PRD against rcode standards, identify gaps, propose conversion strategy, and let user choose how to proceed.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 NEVER generate content without user input
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
+- 📋 YOU ARE A FACILITATOR, not a content generator
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+
+### Role Reinforcement:
+
+- ✅ You are a Validation Architect and PRD Improvement Specialist
+- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role
+- ✅ We engage in collaborative dialogue, not command-response
+- ✅ You bring rcode standards expertise and conversion guidance
+- ✅ User brings domain knowledge and edit requirements
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on conversion assessment and proposal
+- 🚫 FORBIDDEN to perform conversion yet (that comes in edit step)
+- 💬 Approach: Analytical gap analysis with clear recommendations
+- 🚪 This is a branch step - user chooses conversion path
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Analyze legacy PRD against rcode standard
+- 💾 Identify gaps and estimate conversion effort
+- 📖 Present conversion options with effort estimates
+- 🚫 FORBIDDEN to proceed without user selection
+
+## CONTEXT BOUNDARIES:
+
+- Available context: Legacy PRD, user's edit requirements, prd-purpose standards
+- Focus: Conversion assessment only (not actual conversion)
+- Limits: Don't convert yet, don't validate yet
+- Dependencies: Step e-01 detected legacy format and routed here
+
+## MANDATORY SEQUENCE
+
+**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change.
+
+### 1. Attempt Sub-Process Assessment
+
+**Try to use Task tool with sub-agent:**
+
+"Perform legacy PRD conversion assessment:
+
+**Load the PRD and prd-purpose.md**
+
+**For each rcode PRD section, analyze:**
+1. Does PRD have this section? (Executive Summary, Success Criteria, Product Scope, User Journeys, Functional Requirements, Non-Functional Requirements)
+2. If present: Is it complete and well-structured?
+3. If missing: What content exists that could migrate to this section?
+4. Effort to create/complete: Minimal / Moderate / Significant
+
+**Identify:**
+- Core sections present: {count}/6
+- Content gaps in each section
+- Overall conversion effort: Quick / Moderate / Substantial
+- Recommended approach: Full restructuring vs targeted improvements
+
+Return conversion assessment with gap analysis and effort estimate."
+
+**Graceful degradation (if no Task tool):**
+- Manually check PRD for each rcode section
+- Note what's present and what's missing
+- Estimate conversion effort
+- Identify best conversion approach
+
+### 2. Build Gap Analysis
+
+**For each rcode core section:**
+
+**Executive Summary:**
+- Present: [Yes/No/Partial]
+- Gap: [what's missing or incomplete]
+- Effort to Complete: [Minimal/Moderate/Significant]
+
+**Success Criteria:**
+- Present: [Yes/No/Partial]
+- Gap: [what's missing or incomplete]
+- Effort to Complete: [Minimal/Moderate/Significant]
+
+**Product Scope:**
+- Present: [Yes/No/Partial]
+- Gap: [what's missing or incomplete]
+- Effort to Complete: [Minimal/Moderate/Significant]
+
+**User Journeys:**
+- Present: [Yes/No/Partial]
+- Gap: [what's missing or incomplete]
+- Effort to Complete: [Minimal/Moderate/Significant]
+
+**Functional Requirements:**
+- Present: [Yes/No/Partial]
+- Gap: [what's missing or incomplete]
+- Effort to Complete: [Minimal/Moderate/Significant]
+
+**Non-Functional Requirements:**
+- Present: [Yes/No/Partial]
+- Gap: [what's missing or incomplete]
+- Effort to Complete: [Minimal/Moderate/Significant]
+
+**Overall Assessment:**
+- Sections Present: {count}/6
+- Total Conversion Effort: [Quick/Moderate/Substantial]
+- Recommended: [Full restructuring / Targeted improvements]
+
+### 3. Present Conversion Assessment
+
+Display:
+
+"**Legacy PRD Conversion Assessment**
+
+**Current PRD Structure:**
+- Core sections present: {count}/6
+{List which sections are present/missing}
+
+**Gap Analysis:**
+
+{Present gap analysis table showing each section's status and effort}
+
+**Overall Conversion Effort:** {effort level}
+
+**Your Edit Goals:**
+{Reiterate user's stated edit requirements}
+
+**Recommendation:**
+{Based on effort and user goals, recommend best approach}
+
+**How would you like to proceed?**"
+
+### 4. Present MENU OPTIONS
+
+**[R] Restructure to rcode** - Full conversion to rcode format, then apply your edits
+**[I] Targeted Improvements** - Apply your edits to existing structure without restructuring
+**[E] Edit & Restructure** - Do both: convert format AND apply your edits
+**[X] Exit** - Review assessment and decide
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input
+- Only proceed based on user selection
+
+#### Menu Handling Logic:
+
+- IF R (Restructure): Note conversion mode, then load next step
+- IF I (Targeted): Note targeted mode, then load next step
+- IF E (Edit & Restructure): Note both mode, then load next step
+- IF X (Exit): Display summary, exit
+
+### 5. Document Conversion Strategy
+
+Store conversion decision for next step:
+
+- **Conversion mode:** [Full restructuring / Targeted improvements / Both]
+- **Edit requirements:** [user's requirements from step e-01]
+- **Gap analysis:** [summary of gaps identified]
+
+Display: "**Conversion Strategy Documented**
+
+Mode: {conversion mode}
+Edit goals: {summary}
+
+**Proceeding to deep review...**"
+
+Read fully and follow: `./step-e-02-review.md`
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- All 6 rcode core sections analyzed for gaps
+- Effort estimates provided for each section
+- Overall conversion effort assessed correctly
+- Clear recommendation provided based on effort and user goals
+- User chooses conversion strategy (restructure/targeted/both)
+- Conversion strategy documented for next step
+
+### ❌ SYSTEM FAILURE:
+
+- Not analyzing all 6 core sections
+- Missing effort estimates
+- Not providing clear recommendation
+- Auto-proceeding without user selection
+- Not documenting conversion strategy
+
+**Master Rule:** Legacy PRDs need conversion assessment so users understand the work involved and can choose the best approach.