olympus-ai 4.5.13 → 4.5.14

package/resources/rules/construction/nfr-design.md

@@ -1,106 +1,106 @@
-# NFR Design
-
-## Prerequisites
-- NFR Requirements must be complete for the unit
-- NFR requirements artifacts must be available
-- Execution plan must indicate NFR Design stage should execute
-
-## Agent Delegation Strategy
-
-**MANDATORY**: Delegate NFR design artifact generation (Step 6) to `oracle-medium`. Do NOT generate design patterns and logical components directly.
-
-**Execution mode**: Foreground sequential — single coherent design task per unit.
-
-**Delegation scope**:
-- **Orchestrator retains**: Steps 1-5 (analyze NFR requirements, plan creation, Q&A, answer collection) and Steps 7-9 (completion message, approval gate, state update).
-- **Delegated to `oracle-medium`**: Step 6 (Generate NFR Design Artifacts) — the agent incorporates NFR requirements into design patterns, producing nfr-design-patterns.md and logical-components.md.
-
-**If an agent task fails**: Follow the Agent Task Failure Recovery procedure in `error-handling.md` — retry the delegation, never silently do the work yourself.
-
-**After agent completes**: The orchestrator compiles the agent's output into the artifact files, presents the completion message, and manages the approval gate.
-
-## Overview
-Incorporate NFR requirements into unit design using patterns and logical components.
-
-## Steps to Execute
-
-### Step 1: Analyze NFR Requirements
-- Read NFR requirements from `aidlc-docs/construction/{unit-name}/nfr-requirements/`
-- Understand scalability, performance, availability, security needs
-
-### Step 2: Create NFR Design Plan
-- Generate plan with checkboxes [] for NFR design
-- Focus on design patterns and logical components
-- Each step should have a checkbox []
-
-### Step 3: Generate Context-Appropriate Questions
-**DIRECTIVE**: Analyze the NFR requirements to generate ONLY questions relevant to THIS specific unit's NFR design. Use the categories below as inspiration, NOT as a mandatory checklist. Skip entire categories if not applicable.
-
-- EMBED questions using [Answer]: tag format
-- Focus on ambiguities and missing information specific to this unit
-- Generate questions only where user input is needed for pattern and component decisions
-
-**Example question categories** (adapt as needed):
-- **Resilience Patterns** - Only if fault tolerance approach needs clarification
-- **Scalability Patterns** - Only if scaling mechanisms are unclear
-- **Performance Patterns** - Only if performance optimization strategy is ambiguous
-- **Security Patterns** - Only if security implementation approach needs input
-- **Logical Components** - Only if infrastructure components (queues, caches, etc.) need clarification
-
-### Step 4: Store Plan
-- Save as `aidlc-docs/construction/plans/{unit-name}-nfr-design-plan.md`
-- Include all [Answer]: tags for user input
-
-### Step 5: Collect and Analyze Answers
-- Wait for user to complete all [Answer]: tags
-- Review for vague or ambiguous responses
-- Add follow-up questions if needed
-
-### Step 6: Generate NFR Design Artifacts
-- Create `aidlc-docs/construction/{unit-name}/nfr-design/nfr-design-patterns.md`
-- Create `aidlc-docs/construction/{unit-name}/nfr-design/logical-components.md`
-
-### Step 7: Present Completion Message
-- Present completion message in this structure:
-     1. **Completion Announcement** (mandatory): Always start with this:
-
-```markdown
-# 🎨 NFR Design Complete - [unit-name]
-```
-
-     2. **AI Summary** (optional): Provide structured bullet-point summary of NFR design
-        - Format: "NFR design has incorporated [description]:"
-        - List key design patterns implemented (bullet points)
-        - List logical components and infrastructure elements
-        - Mention resilience, scalability, and performance patterns applied
-        - DO NOT include workflow instructions ("please review", "let me know", "proceed to next phase", "before we proceed")
-        - Keep factual and content-focused
-     3. **Formatted Workflow Message** (mandatory): Always end with this exact format:
-
-```markdown
----
-
-⚠️ **REVIEW REQUIRED**
-
-> Please examine the NFR design at:
-> `aidlc-docs/{workflow-id}/construction/[unit-name]/nfr-design/`
-
-**You may:**
-- 🔧 **Request Changes** — Ask for modifications to the NFR design based on your review
-- ✅ **Continue to Next Stage** — Approve NFR design and proceed to **[next-stage-name]**
-
----
-```
-
-### Step 8: Wait for Explicit Approval
-- Do not proceed until the user explicitly approves the NFR design
-- Approval must be clear and unambiguous
-- If user requests changes, update the design and repeat the approval process
-
-### Step 9: Record Approval and MANDATORY State Update
-- Log approval in audit.md with timestamp
-- Record the user's approval response with timestamp
-- **MANDATORY**: Update BOTH state files in the SAME interaction:
-  1. Mark NFR Design stage complete in `aidlc-docs/{workflow-id}/aidlc-state.md`
-  2. Update `aidlc-docs/{workflow-id}/checkpoint.json` — set nfr-design status to "completed" with completed_at timestamp
-- **Do NOT proceed to the next stage without completing state updates**
+# NFR Design
+
+## Prerequisites
+- NFR Requirements must be complete for the unit
+- NFR requirements artifacts must be available
+- Execution plan must indicate NFR Design stage should execute
+
+## Agent Delegation Strategy
+
+**MANDATORY**: Delegate NFR design artifact generation (Step 6) to `oracle-medium`. Do NOT generate design patterns and logical components directly.
+
+**Execution mode**: Foreground sequential — single coherent design task per unit.
+
+**Delegation scope**:
+- **Orchestrator retains**: Steps 1-5 (analyze NFR requirements, plan creation, Q&A, answer collection) and Steps 7-9 (completion message, approval gate, state update).
+- **Delegated to `oracle-medium`**: Step 6 (Generate NFR Design Artifacts) — the agent incorporates NFR requirements into design patterns, producing nfr-design-patterns.md and logical-components.md.
+
+**If an agent task fails**: Follow the Agent Task Failure Recovery procedure in `error-handling.md` — retry the delegation, never silently do the work yourself.
+
+**After agent completes**: The orchestrator compiles the agent's output into the artifact files, presents the completion message, and manages the approval gate.
+
+## Overview
+Incorporate NFR requirements into unit design using patterns and logical components.
+
+## Steps to Execute
+
+### Step 1: Analyze NFR Requirements
+- Read NFR requirements from `aidlc-docs/construction/{unit-name}/nfr-requirements/`
+- Understand scalability, performance, availability, security needs
+
+### Step 2: Create NFR Design Plan
+- Generate plan with checkboxes [] for NFR design
+- Focus on design patterns and logical components
+- Each step should have a checkbox []
+
+### Step 3: Generate Context-Appropriate Questions
+**DIRECTIVE**: Analyze the NFR requirements to generate ONLY questions relevant to THIS specific unit's NFR design. Use the categories below as inspiration, NOT as a mandatory checklist. Skip entire categories if not applicable.
+
+- EMBED questions using [Answer]: tag format
+- Focus on ambiguities and missing information specific to this unit
+- Generate questions only where user input is needed for pattern and component decisions
+
+**Example question categories** (adapt as needed):
+- **Resilience Patterns** - Only if fault tolerance approach needs clarification
+- **Scalability Patterns** - Only if scaling mechanisms are unclear
+- **Performance Patterns** - Only if performance optimization strategy is ambiguous
+- **Security Patterns** - Only if security implementation approach needs input
+- **Logical Components** - Only if infrastructure components (queues, caches, etc.) need clarification
+
+### Step 4: Store Plan
+- Save as `aidlc-docs/construction/plans/{unit-name}-nfr-design-plan.md`
+- Include all [Answer]: tags for user input
+
+### Step 5: Collect and Analyze Answers
+- Wait for user to complete all [Answer]: tags
+- Review for vague or ambiguous responses
+- Add follow-up questions if needed
+
+### Step 6: Generate NFR Design Artifacts
+- Create `aidlc-docs/construction/{unit-name}/nfr-design/nfr-design-patterns.md`
+- Create `aidlc-docs/construction/{unit-name}/nfr-design/logical-components.md`
+
+### Step 7: Present Completion Message
+- Present completion message in this structure:
+     1. **Completion Announcement** (mandatory): Always start with this:
+
+```markdown
+# 🎨 NFR Design Complete - [unit-name]
+```
+
+     2. **AI Summary** (optional): Provide structured bullet-point summary of NFR design
+        - Format: "NFR design has incorporated [description]:"
+        - List key design patterns implemented (bullet points)
+        - List logical components and infrastructure elements
+        - Mention resilience, scalability, and performance patterns applied
+        - DO NOT include workflow instructions ("please review", "let me know", "proceed to next phase", "before we proceed")
+        - Keep factual and content-focused
+     3. **Formatted Workflow Message** (mandatory): Always end with this exact format:
+
+```markdown
+---
+
+⚠️ **REVIEW REQUIRED**
+
+> Please examine the NFR design at:
+> `aidlc-docs/{workflow-id}/construction/[unit-name]/nfr-design/`
+
+**You may:**
+- 🔧 **Request Changes** — Ask for modifications to the NFR design based on your review
+- ✅ **Continue to Next Stage** — Approve NFR design and proceed to **[next-stage-name]**
+
+---
+```
+
+### Step 8: Wait for Explicit Approval
+- Do not proceed until the user explicitly approves the NFR design
+- Approval must be clear and unambiguous
+- If user requests changes, update the design and repeat the approval process
+
+### Step 9: Record Approval and MANDATORY State Update
+- Log approval in audit.md with timestamp
+- Record the user's approval response with timestamp
+- **MANDATORY**: Update BOTH state files in the SAME interaction:
+  1. Mark NFR Design stage complete in `aidlc-docs/{workflow-id}/aidlc-state.md`
+  2. Update `aidlc-docs/{workflow-id}/checkpoint.json` — set nfr-design status to "completed" with completed_at timestamp
+- **Do NOT proceed to the next stage without completing state updates**

package/resources/rules/construction/nfr-requirements.md

@@ -1,118 +1,118 @@
-# NFR Requirements
-
-## Prerequisites
-- Functional Design must be complete for the unit
-- Unit functional design artifacts must be available
-- Execution plan must indicate NFR Requirements stage should execute
-
-## Agent Delegation Strategy
-
-**MANDATORY**: Delegate NFR assessment artifact generation (Step 6) to `oracle-medium`. Do NOT generate NFR requirements and tech stack decisions directly.
-
-**Execution mode**: Foreground sequential — single coherent assessment task per unit.
-
-**Delegation scope**:
-- **Orchestrator retains**: Steps 1-5 (analyze functional design, plan creation, Q&A, answer collection) and Steps 7-9 (completion message, approval gate, state update).
-- **Delegated to `oracle-medium`**: Step 6 (Generate NFR Requirements Artifacts) — the agent analyzes functional design context and user answers to produce nfr-requirements.md and tech-stack-decisions.md.
-
-**If an agent task fails**: Follow the Agent Task Failure Recovery procedure in `error-handling.md` — retry the delegation, never silently do the work yourself.
-
-**After agent completes**: The orchestrator compiles the agent's output into the artifact files, presents the completion message, and manages the approval gate.
-
-**Optional technology validation — `librarian`**:
-When user answers in Step 5 name specific technologies, frameworks, or cloud services (e.g., "use Kafka", "Redis for caching", "Next.js 15"), the orchestrator may optionally invoke `librarian` to validate those choices against current documentation. Librarian can verify version compatibility, licensing terms, known limitations, and service-specific constraints that `oracle-medium` may not have in its training data. This is not mandatory — only invoke when specific technology names appear in user answers and validation would improve the accuracy of tech-stack-decisions.md.
-
-## Overview
-Determine non-functional requirements for the unit and make tech stack choices.
-
-## Steps to Execute
-
-### Step 1: Analyze Functional Design
-- Read functional design artifacts from `aidlc-docs/construction/{unit-name}/functional-design/`
-- Understand business logic complexity and requirements
-
-### Step 2: Create NFR Requirements Plan
-- Generate plan with checkboxes [] for NFR assessment
-- Focus on scalability, performance, availability, security
-- Each step should have a checkbox []
-
-### Step 3: Generate Context-Appropriate Questions
-**DIRECTIVE**: Thoroughly analyze the functional design to identify ALL areas where NFR clarification would improve system quality and architecture decisions. Be proactive in asking questions to ensure comprehensive NFR coverage.
-
-**CRITICAL**: Default to asking questions when there is ANY ambiguity or missing detail that could affect system quality. It's better to ask too many questions than to make incorrect NFR assumptions.
-
-- EMBED questions using [Answer]: tag format
-- Focus on ANY ambiguities, missing information, or areas needing clarification
-- Generate questions wherever user input would improve NFR and tech stack decisions
-- **When in doubt, ask the question** - overconfidence leads to poor system quality
-
-**Question categories to evaluate** (consider ALL categories):
-- **Scalability Requirements** - Ask about expected load, growth patterns, scaling triggers, and capacity planning
-- **Performance Requirements** - Ask about response times, throughput, latency, and performance benchmarks
-- **Availability Requirements** - Ask about uptime expectations, disaster recovery, failover, and business continuity
-- **Security Requirements** - Ask about data protection, compliance, authentication, authorization, and threat models
-- **Tech Stack Selection** - Ask about technology preferences, constraints, existing systems, and integration requirements
-- **Reliability Requirements** - Ask about error handling, fault tolerance, monitoring, and alerting needs
-- **Maintainability Requirements** - Ask about code quality, documentation, testing, and operational requirements
-- **Usability Requirements** - Ask about user experience, accessibility, and interface requirements
-
-### Step 4: Store Plan
-- Save as `aidlc-docs/construction/plans/{unit-name}-nfr-requirements-plan.md`
-- Include all [Answer]: tags for user input
-
-### Step 5: Collect and Analyze Answers
-- Wait for user to complete all [Answer]: tags
-- **MANDATORY**: Carefully review ALL responses for vague or ambiguous answers
-- **CRITICAL**: Add follow-up questions for ANY unclear responses - do not proceed with ambiguity
-- Look for responses like "depends", "maybe", "not sure", "mix of", "somewhere between", "standard", "typical"
-- Create clarification questions file if ANY ambiguities are detected
-- **Do not proceed until ALL ambiguities are resolved**
-
-### Step 6: Generate NFR Requirements Artifacts
-- Create `aidlc-docs/construction/{unit-name}/nfr-requirements/nfr-requirements.md`
-- Create `aidlc-docs/construction/{unit-name}/nfr-requirements/tech-stack-decisions.md`
-
-### Step 7: Present Completion Message
-- Present completion message in this structure:
-     1. **Completion Announcement** (mandatory): Always start with this:
-
-```markdown
-# 📊 NFR Requirements Complete - [unit-name]
-```
-
-     2. **AI Summary** (optional): Provide structured bullet-point summary of NFR requirements
-        - Format: "NFR requirements assessment has identified [description]:"
-        - List key scalability, performance, availability requirements (bullet points)
-        - List security and compliance requirements identified
-        - Mention tech stack decisions and rationale
-        - DO NOT include workflow instructions ("please review", "let me know", "proceed to next phase", "before we proceed")
-        - Keep factual and content-focused
-     3. **Formatted Workflow Message** (mandatory): Always end with this exact format:
-
-```markdown
----
-
-⚠️ **REVIEW REQUIRED**
-
-> Please examine the NFR requirements at:
-> `aidlc-docs/{workflow-id}/construction/[unit-name]/nfr-requirements/`
-
-**You may:**
-- 🔧 **Request Changes** — Ask for modifications to the NFR requirements based on your review
-- ✅ **Continue to Next Stage** — Approve NFR requirements and proceed to **[next-stage-name]**
-
----
-```
-
-### Step 8: Wait for Explicit Approval
-- Do not proceed until the user explicitly approves the NFR requirements
-- Approval must be clear and unambiguous
-- If user requests changes, update the requirements and repeat the approval process
-
-### Step 9: Record Approval and MANDATORY State Update
-- Log approval in audit.md with timestamp
-- Record the user's approval response with timestamp
-- **MANDATORY**: Update BOTH state files in the SAME interaction:
-  1. Mark NFR Requirements stage complete in `aidlc-docs/{workflow-id}/aidlc-state.md`
-  2. Update `aidlc-docs/{workflow-id}/checkpoint.json` — set nfr-requirements status to "completed" with completed_at timestamp
-- **Do NOT proceed to the next stage without completing state updates**
+# NFR Requirements
+
+## Prerequisites
+- Functional Design must be complete for the unit
+- Unit functional design artifacts must be available
+- Execution plan must indicate NFR Requirements stage should execute
+
+## Agent Delegation Strategy
+
+**MANDATORY**: Delegate NFR assessment artifact generation (Step 6) to `oracle-medium`. Do NOT generate NFR requirements and tech stack decisions directly.
+
+**Execution mode**: Foreground sequential — single coherent assessment task per unit.
+
+**Delegation scope**:
+- **Orchestrator retains**: Steps 1-5 (analyze functional design, plan creation, Q&A, answer collection) and Steps 7-9 (completion message, approval gate, state update).
+- **Delegated to `oracle-medium`**: Step 6 (Generate NFR Requirements Artifacts) — the agent analyzes functional design context and user answers to produce nfr-requirements.md and tech-stack-decisions.md.
+
+**If an agent task fails**: Follow the Agent Task Failure Recovery procedure in `error-handling.md` — retry the delegation, never silently do the work yourself.
+
+**After agent completes**: The orchestrator compiles the agent's output into the artifact files, presents the completion message, and manages the approval gate.
+
+**Optional technology validation — `librarian`**:
+When user answers in Step 5 name specific technologies, frameworks, or cloud services (e.g., "use Kafka", "Redis for caching", "Next.js 15"), the orchestrator may optionally invoke `librarian` to validate those choices against current documentation. Librarian can verify version compatibility, licensing terms, known limitations, and service-specific constraints that `oracle-medium` may not have in its training data. This is not mandatory — only invoke when specific technology names appear in user answers and validation would improve the accuracy of tech-stack-decisions.md.
+
+## Overview
+Determine non-functional requirements for the unit and make tech stack choices.
+
+## Steps to Execute
+
+### Step 1: Analyze Functional Design
+- Read functional design artifacts from `aidlc-docs/construction/{unit-name}/functional-design/`
+- Understand business logic complexity and requirements
+
+### Step 2: Create NFR Requirements Plan
+- Generate plan with checkboxes [] for NFR assessment
+- Focus on scalability, performance, availability, security
+- Each step should have a checkbox []
+
+### Step 3: Generate Context-Appropriate Questions
+**DIRECTIVE**: Thoroughly analyze the functional design to identify ALL areas where NFR clarification would improve system quality and architecture decisions. Be proactive in asking questions to ensure comprehensive NFR coverage.
+
+**CRITICAL**: Default to asking questions when there is ANY ambiguity or missing detail that could affect system quality. It's better to ask too many questions than to make incorrect NFR assumptions.
+
+- EMBED questions using [Answer]: tag format
+- Focus on ANY ambiguities, missing information, or areas needing clarification
+- Generate questions wherever user input would improve NFR and tech stack decisions
+- **When in doubt, ask the question** - overconfidence leads to poor system quality
+
+**Question categories to evaluate** (consider ALL categories):
+- **Scalability Requirements** - Ask about expected load, growth patterns, scaling triggers, and capacity planning
+- **Performance Requirements** - Ask about response times, throughput, latency, and performance benchmarks
+- **Availability Requirements** - Ask about uptime expectations, disaster recovery, failover, and business continuity
+- **Security Requirements** - Ask about data protection, compliance, authentication, authorization, and threat models
+- **Tech Stack Selection** - Ask about technology preferences, constraints, existing systems, and integration requirements
+- **Reliability Requirements** - Ask about error handling, fault tolerance, monitoring, and alerting needs
+- **Maintainability Requirements** - Ask about code quality, documentation, testing, and operational requirements
+- **Usability Requirements** - Ask about user experience, accessibility, and interface requirements
+
+### Step 4: Store Plan
+- Save as `aidlc-docs/construction/plans/{unit-name}-nfr-requirements-plan.md`
+- Include all [Answer]: tags for user input
+
+### Step 5: Collect and Analyze Answers
+- Wait for user to complete all [Answer]: tags
+- **MANDATORY**: Carefully review ALL responses for vague or ambiguous answers
+- **CRITICAL**: Add follow-up questions for ANY unclear responses - do not proceed with ambiguity
+- Look for responses like "depends", "maybe", "not sure", "mix of", "somewhere between", "standard", "typical"
+- Create clarification questions file if ANY ambiguities are detected
+- **Do not proceed until ALL ambiguities are resolved**
+
+### Step 6: Generate NFR Requirements Artifacts
+- Create `aidlc-docs/construction/{unit-name}/nfr-requirements/nfr-requirements.md`
+- Create `aidlc-docs/construction/{unit-name}/nfr-requirements/tech-stack-decisions.md`
+
+### Step 7: Present Completion Message
+- Present completion message in this structure:
+     1. **Completion Announcement** (mandatory): Always start with this:
+
+```markdown
+# 📊 NFR Requirements Complete - [unit-name]
+```
+
+     2. **AI Summary** (optional): Provide structured bullet-point summary of NFR requirements
+        - Format: "NFR requirements assessment has identified [description]:"
+        - List key scalability, performance, availability requirements (bullet points)
+        - List security and compliance requirements identified
+        - Mention tech stack decisions and rationale
+        - DO NOT include workflow instructions ("please review", "let me know", "proceed to next phase", "before we proceed")
+        - Keep factual and content-focused
+     3. **Formatted Workflow Message** (mandatory): Always end with this exact format:
+
+```markdown
+---
+
+⚠️ **REVIEW REQUIRED**
+
+> Please examine the NFR requirements at:
+> `aidlc-docs/{workflow-id}/construction/[unit-name]/nfr-requirements/`
+
+**You may:**
+- 🔧 **Request Changes** — Ask for modifications to the NFR requirements based on your review
+- ✅ **Continue to Next Stage** — Approve NFR requirements and proceed to **[next-stage-name]**
+
+---
+```
+
+### Step 8: Wait for Explicit Approval
+- Do not proceed until the user explicitly approves the NFR requirements
+- Approval must be clear and unambiguous
+- If user requests changes, update the requirements and repeat the approval process
+
+### Step 9: Record Approval and MANDATORY State Update
+- Log approval in audit.md with timestamp
+- Record the user's approval response with timestamp
+- **MANDATORY**: Update BOTH state files in the SAME interaction:
+  1. Mark NFR Requirements stage complete in `aidlc-docs/{workflow-id}/aidlc-state.md`
+  2. Update `aidlc-docs/{workflow-id}/checkpoint.json` — set nfr-requirements status to "completed" with completed_at timestamp
+- **Do NOT proceed to the next stage without completing state updates**