x-ipe 1.0.23__py3-none-any.whl → 1.0.25__py3-none-any.whl

x_ipe/resources/skills/x-ipe-skill-creator-v3/references/examples.md

@@ -0,0 +1,429 @@
+# X-IPE Skill Creator - Examples
+
+Concrete execution examples for the skill-creator workflow. This file contains at least 3 complete examples covering different skill types.
+
+---
+
+## Example 1: Create Task Type Skill
+
+**Request:** "Create a skill for bug fixing"
+
+### Step 1: Identify Skill Type
+
+```yaml
+input:
+  user_request: "bug fixing"
+  analysis: "Development lifecycle workflow"
+  
+output:
+  skill_type: x-ipe-task-based
+  template: templates/task-type-skill.md
+```
+
+### Step 2: Gather Examples
+
+```yaml
+user_examples:
+  - "Fix the login button that's not working"
+  - "Debug the null pointer exception in UserService"
+  - "This test is failing, can you fix it?"
+
+trigger_patterns:
+  - "fix bug"
+  - "debug"
+  - "failing test"
+  - "not working"
+```
+
+### Step 3: Plan Resources
+
+```yaml
+resources_plan:
+  templates: null
+  references:
+    - examples.md  # REQUIRED for x-ipe-task-based
+  scripts: null
+```
+
+### Steps 4-5: Round 1 (Parallel)
+
+**Sub-agent 1 Output: skill-meta.md**
+
+```yaml
+skill_name: task-type-bug-fix
+skill_type: x-ipe-task-based
+acceptance_criteria:
+  must:
+    - id: AC-M01
+      description: Failing test written before fix
+    - id: AC-M02
+      description: Root cause identified
+    - id: AC-M03
+      description: All tests pass after fix
+```
+
+**Sub-agent 2 Output: candidate/**
+
+```
+candidate/
+├── SKILL.md (task-type-bug-fix skill)
+└── references/
+    └── examples.md (bug fix examples)
+```
+
+### Steps 6-7: Round 2 (Parallel)
+
+**Sub-agent 3: Reflect**
+
+```yaml
+gaps_found:
+  - section: Definition of Ready
+    issue: "Missing reproduction steps prerequisite"
+    fix: "Added checkpoint: Reproduction steps documented"
+```
+
+**Sub-agent 4: Generate Tests**
+
+```yaml
+test_cases:
+  - id: TC-001
+    source_ac: AC-M01
+    scenario: Fix login button bug
+    expected: Failing test exists before fix applied
+```
+
+### Steps 8-9: Run and Evaluate
+
+```yaml
+evaluation_result:
+  must_pass_rate: 100%
+  should_pass_rate: 85%
+  overall_pass: true
+```
+
+### Step 10: Merge
+
+```bash
+cp -r candidate/* .github/skills/task-type-bug-fix/
+```
+
+### Step 11: Cross-References
+
+```yaml
+cross_reference_checks:
+  copilot_instructions_registry: added
+  task_execution_guideline: added
+  status: valid
+```
+
+---
+
+## Example 2: Create Tool Skill
+
+**Request:** "Create a skill for generating PDF documents"
+
+### Step 1: Identify Skill Type
+
+```yaml
+input:
+  user_request: "PDF documents"
+  analysis: "Utility function"
+  
+output:
+  skill_type: tool_skill
+  template: templates/tool-skill.md
+```
+
+### Step 2: Gather Examples
+
+```yaml
+user_examples:
+  - "Convert this markdown to PDF"
+  - "Extract text from PDF"
+  - "Merge these PDFs together"
+
+trigger_patterns:
+  - "create PDF"
+  - "extract from PDF"
+  - "merge PDF"
+```
+
+### Step 3: Plan Resources
+
+```yaml
+resources_plan:
+  templates:
+    - pdf-template.md
+  references:
+    - pdf-library-docs.md
+  scripts:
+    - pdf-generator.py
+    - pdf-extractor.py
+```
+
+### Execution Summary
+
+```yaml
+workflow_execution:
+  round_1: "Created skill-meta.md + candidate/"
+  round_2: "Reflected, generated 5 test cases"
+  round_3: "Ran tests (PDF generation, extraction, merge)"
+  round_4: "Evaluated - all passed"
+  
+merge_target: ".github/skills/pdf/"
+```
+
+---
+
+## Example 3: Create Workflow Orchestration Skill
+
+**Request:** "Create a workflow that handles the full feature development pipeline from refinement to closing"
+
+### Step 1: Identify Skill Type
+
+```yaml
+input:
+  user_request: "full feature development pipeline"
+  analysis: "Orchestrates multiple skills"
+  
+output:
+  skill_type: workflow_orchestration
+  template: templates/workflow-skill.md
+```
+
+### Step 2: Gather Examples
+
+```yaml
+user_examples:
+  - "Run the complete feature workflow for FEAT-001"
+  - "Execute the full pipeline from refinement to PR"
+  - "Automate the feature development process"
+
+trigger_patterns:
+  - "full pipeline"
+  - "complete workflow"
+  - "feature development flow"
+```
+
+### Step 3: Plan Resources
+
+```yaml
+resources_plan:
+  templates: null
+  references:
+    - examples.md
+    - skill-registry.md  # Documents orchestrated skills
+  scripts: null
+
+orchestrated_skills:
+  - task-type-feature-refinement
+  - task-type-technical-design
+  - task-type-test-generation
+  - task-type-code-implementation
+  - task-type-feature-acceptance-test
+  - task-type-feature-closing
+```
+
+### Steps 4-5: Round 1 (Parallel)
+
+**Sub-agent 1 Output: skill-meta.md**
+
+```yaml
+skill_name: feature+full-pipeline
+skill_type: workflow_orchestration
+acceptance_criteria:
+  must:
+    - id: AC-M01
+      description: All 6 skills execute in correct order
+    - id: AC-M02
+      description: Data flows correctly between skills
+    - id: AC-M03
+      description: Failure in any skill triggers appropriate handling
+  should:
+    - id: AC-S01
+      description: Parallel execution where dependencies allow
+    - id: AC-S02
+      description: Human review gates respected
+```
+
+**Sub-agent 2 Output: candidate/**
+
+```
+candidate/
+├── SKILL.md (feature+full-pipeline orchestration)
+└── references/
+    ├── examples.md
+    └── skill-registry.md
+```
+
+### Skill Registry in SKILL.md
+
+```yaml
+skill_registry:
+  - skill: task-type-feature-refinement
+    phase: 1
+    input: feature_id
+    output: specification_path
+    
+  - skill: task-type-technical-design
+    phase: 2
+    input: specification_path
+    output: design_path
+    
+  - skill: task-type-test-generation
+    phase: 3
+    input: design_path
+    output: test_files[]
+    
+  - skill: task-type-code-implementation
+    phase: 4
+    input: design_path, test_files[]
+    output: implementation_files[]
+    
+  - skill: task-type-feature-acceptance-test
+    phase: 5
+    input: implementation_files[]
+    output: acceptance_report
+    
+  - skill: task-type-feature-closing
+    phase: 6
+    input: acceptance_report
+    output: pr_url
+```
+
+### Execution Summary
+
+```yaml
+workflow_execution:
+  round_1: "Created skill-meta.md + candidate/"
+  round_2: "Reflected on skill coordination, generated 8 test cases"
+  round_3: "Ran tests (happy path, failure scenarios, data flow)"
+  round_4: "Evaluated - all passed"
+  
+merge_target: ".github/skills/feature+full-pipeline/"
+```
+
+---
+
+## Example 4: Update Skill from Lessons
+
+**Scenario:** Lesson-learned captured that task-type-bug-fix skill misses edge case
+
+### Pre-Step: Check Lessons
+
+```yaml
+file: x-ipe-docs/skill-meta/task-type-bug-fix/lesson-learned.md
+
+lessons:
+  - id: LL-001
+    status: raw
+    issue: "Skill doesn't handle flaky test scenarios"
+    suggestion: "Add pattern for flaky test isolation"
+```
+
+### Step 1: Read Lessons
+
+```yaml
+lesson_analysis:
+  lesson_id: LL-001
+  issue: "Flaky test handling missing"
+  action: "Convert to acceptance criterion"
+```
+
+### Step 2: Update skill-meta.md
+
+```yaml
+acceptance_criteria:
+  should:
+    - id: AC-S04  # NEW
+      description: Handles flaky test scenarios
+      test_method: content_check
+      expected: "Pattern for flaky test isolation exists"
+```
+
+### Steps 3-11: Normal Workflow
+
+```yaml
+workflow_execution:
+  - "Updated candidate/ with flaky test pattern"
+  - "Generated test for AC-S04"
+  - "Ran tests - all passed"
+  - "Merged update"
+  - "Updated lesson status to: incorporated"
+```
+
+---
+
+## Example 5: Skill Creation Failure and Iteration
+
+**Request:** "Create a skill for database migrations"
+
+### Round 1-2: Initial Creation
+
+Created candidate skill for database migrations.
+
+### Round 3-4: First Evaluation
+
+```yaml
+evaluation_result:
+  must_pass_rate: 80%  # FAIL - need 100%
+  overall_pass: false
+  failed_tests:
+    - id: TC-003
+      issue: "DoR missing database connection prerequisite"
+```
+
+### Iteration 1: Fix and Re-run
+
+```yaml
+fix_applied:
+  section: Definition of Ready
+  change: "Added checkpoint: Database connection available"
+  
+action: "Re-run from Round 2"
+```
+
+### Round 4: Second Evaluation
+
+```yaml
+evaluation_result:
+  must_pass_rate: 100%  # PASS
+  should_pass_rate: 75%  # Below 80% threshold
+  overall_pass: false
+  failed_tests:
+    - id: TC-007
+      issue: "Rollback procedure not documented"
+```
+
+### Iteration 2: Fix and Re-run
+
+```yaml
+fix_applied:
+  section: Execution Procedure
+  change: "Added rollback procedure steps"
+  
+action: "Re-run from Round 2"
+```
+
+### Final Evaluation
+
+```yaml
+evaluation_result:
+  must_pass_rate: 100%
+  should_pass_rate: 88%
+  overall_pass: true
+
+merge_target: ".github/skills/task-type-database-migration/"
+```
+
+---
+
+## Summary of Examples
+
+| Example | Skill Type | Key Learning |
+|---------|------------|--------------|
+| 1 | task_type | Full happy path for task-type-bug-fix |
+| 2 | tool_skill | Tool skill with scripts and templates |
+| 3 | workflow_orchestration | Multi-skill coordination with registry |
+| 4 | Update flow | Incorporating lessons into existing skill |
+| 5 | Failure iteration | How to handle test failures and iterate |