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

x_ipe/resources/skills/x-ipe-skill-creator-v3/templates/x-ipe-workflow-orchestration.md

@@ -0,0 +1,329 @@
+# Workflow Orchestration Skill Template
+
+Use this template when creating a skill that orchestrates multiple other skills in a coordinated workflow. Workflow orchestration skills manage the execution order, data flow, and decision points across multiple skills.
+
+**Section Order (Cognitive Flow):**
+1. CONTEXT: Purpose → Important Notes
+2. DECISION: Input Parameters → Definition of Ready
+3. ACTION: Execution Flow Summary → Execution Procedure
+4. VERIFY: Output Result → Definition of Done
+5. REFERENCE: Registry (Skill Mapping) → Error Handling → Examples
+
+---
+
+```markdown
+---
+name: x-ipe-workflow-{name}
+description: Orchestrates {description of workflow}. Use when {trigger conditions}. Coordinates skills: {skill-1}, {skill-2}, {skill-3}. Triggers on requests like "{trigger 1}", "{trigger 2}".
+---
+
+# {Workflow Name}
+
+## Purpose
+
+Orchestrate a multi-skill workflow by:
+1. **Coordinate** - {Brief description of coordination}
+2. **Sequence** - {Brief description of sequencing logic}
+3. **Aggregate** - {Brief description of result aggregation}
+4. **Handle Failures** - {Brief description of error handling}
+
+---
+
+## Important Notes
+
+BLOCKING: All orchestrated skills must exist and be valid before execution.
+
+CRITICAL: Workflow orchestration skills do NOT implement logic themselves - they coordinate existing skills.
+
+**Note:** If Agent does not have skill capability, go to `.github/skills/` folder to learn skills.
+
+---
+
+## About
+
+Workflow orchestration manages the execution of multiple skills in a defined sequence or parallel pattern.
+
+**Key Concepts:**
+- **Pipeline** - Sequential execution where output of one skill feeds the next
+- **Parallel Group** - Skills that can execute concurrently
+- **Decision Point** - Conditional branching based on skill output
+- **Rollback** - Recovery actions when skills fail
+
+---
+
+## Input Parameters
+
+```yaml
+input:
+  # Workflow trigger
+  workflow_trigger: "{what initiates this workflow}"
+  
+  # Context passed to all skills
+  shared_context:
+    {context_field_1}: "{value}"
+    {context_field_2}: "{value}"
+  
+  # Workflow options
+  options:
+    parallel_execution: true | false
+    stop_on_first_failure: true | false
+    max_retries: {number}
+```
+
+---
+
+## Definition of Ready
+
+```xml
+<definition_of_ready>
+  <checkpoint required="true">
+    <name>All Skills Available</name>
+    <verification>Each skill in registry exists at .github/skills/{skill-name}/SKILL.md</verification>
+  </checkpoint>
+  <checkpoint required="true">
+    <name>Input Context Complete</name>
+    <verification>All required context fields are populated</verification>
+  </checkpoint>
+  <checkpoint required="true">
+    <name>Prerequisites Met</name>
+    <verification>Any workflow-level prerequisites are satisfied</verification>
+  </checkpoint>
+</definition_of_ready>
+```
+
+---
+
+## Execution Flow
+
+| Phase | Skills | Mode | Gate |
+|-------|--------|------|------|
+| 1 | {skill-1} | Sequential | {skill-1} complete |
+| 2 | {skill-2}, {skill-3} | Parallel | Both complete |
+| 3 | {skill-4} | Sequential | Decision: {condition} |
+| 4 | {skill-5} OR {skill-6} | Conditional | Based on Phase 3 decision |
+
+BLOCKING: Skills in same parallel group must have no data dependencies.
+
+---
+
+## Execution Procedure
+
+```xml
+<procedure name="{workflow-name}">
+  <!-- CRITICAL: Both DoR/DoD check elements below are MANDATORY -->
+  <execute_dor_checks_before_starting/>
+  <schedule_dod_checks_with_sub_agent_before_starting/>
+
+  <phase_1>
+    <name>{Phase Name}</name>
+    <skills>
+      <skill name="{skill-1}">
+        <input_mapping>
+          - shared_context.{field} → skill_input.{field}
+        </input_mapping>
+        <output_capture>
+          - skill_output.{field} → workflow_state.{field}
+        </output_capture>
+      </skill>
+    </skills>
+    <gate>workflow_state.{field} is valid</gate>
+  </phase_1>
+
+  <phase_2>
+    <name>{Phase Name}</name>
+    <mode>parallel</mode>
+    <skills>
+      <skill name="{skill-2}">
+        <input_mapping>
+          - workflow_state.{field} → skill_input.{field}
+        </input_mapping>
+      </skill>
+      <skill name="{skill-3}">
+        <input_mapping>
+          - workflow_state.{field} → skill_input.{field}
+        </input_mapping>
+      </skill>
+    </skills>
+    <merge_strategy>
+      - Aggregate results into workflow_state.{merged_field}
+    </merge_strategy>
+    <gate>All parallel skills complete</gate>
+  </phase_2>
+
+  <phase_3>
+    <name>{Decision Phase}</name>
+    <decision>
+      IF: workflow_state.{condition_field} == {value_a}
+      THEN: Execute {skill-5}
+      ELSE: Execute {skill-6}
+    </decision>
+  </phase_3>
+
+</procedure>
+```
+
+---
+
+## Skill Registry
+
+MANDATORY: List all skills this workflow orchestrates with their role.
+
+| Skill | Role in Workflow | Required Input | Produced Output |
+|-------|------------------|----------------|-----------------|
+| `{skill-1}` | {Role description} | {input fields} | {output fields} |
+| `{skill-2}` | {Role description} | {input fields} | {output fields} |
+| `{skill-3}` | {Role description} | {input fields} | {output fields} |
+| `{skill-4}` | {Role description} | {input fields} | {output fields} |
+
+### Data Flow Diagram
+
+```yaml
+data_flow:
+  phase_1:
+    input: shared_context
+    skill: {skill-1}
+    output: result_1
+    
+  phase_2:
+    input: result_1
+    skills: [{skill-2}, {skill-3}]
+    output: [result_2a, result_2b]
+    merge: merged_result
+    
+  phase_3:
+    input: merged_result
+    decision: condition_check
+    branch_a: {skill-5} → final_result_a
+    branch_b: {skill-6} → final_result_b
+```
+
+---
+
+## Output Result
+
+```yaml
+workflow_output:
+  status: completed | partial | failed
+  phases_completed: {number}
+  total_phases: {number}
+  results:
+    phase_1: {result_summary}
+    phase_2: {result_summary}
+    phase_3: {result_summary}
+  failed_skills: []  # If any
+  rollback_executed: true | false
+```
+
+---
+
+## Definition of Done
+
+```xml
+<definition_of_done>
+  <checkpoint required="true">
+    <name>All Required Phases Complete</name>
+    <verification>Each mandatory phase executed successfully</verification>
+  </checkpoint>
+  <checkpoint required="true">
+    <name>Output Aggregated</name>
+    <verification>Final workflow output contains all expected data</verification>
+  </checkpoint>
+  <checkpoint required="true">
+    <name>No Failed Skills</name>
+    <verification>failed_skills array is empty OR failures handled by rollback</verification>
+  </checkpoint>
+</definition_of_done>
+```
+
+---
+
+## Error Handling
+
+| Error | Cause | Recovery |
+|-------|-------|----------|
+| `SKILL_NOT_FOUND` | Referenced skill doesn't exist | Fail workflow, report missing skill |
+| `SKILL_EXECUTION_FAILED` | Skill returned error | Retry (if max_retries > 0), then rollback |
+| `DATA_MAPPING_ERROR` | Input/output field mismatch | Fail workflow, report mapping issue |
+| `PARALLEL_DEADLOCK` | Circular dependency detected | Fail workflow, report dependency cycle |
+
+### Rollback Strategy
+
+```yaml
+rollback:
+  trigger: Any skill failure when stop_on_first_failure == true
+  actions:
+    - step: 1
+      action: "Log failure details"
+    - step: 2  
+      action: "Execute compensating actions for completed skills (if defined)"
+    - step: 3
+      action: "Restore workflow_state to pre-execution snapshot"
+    - step: 4
+      action: "Report final status with rollback flag"
+```
+
+---
+
+## Examples
+
+See [references/examples.md](references/examples.md) for workflow orchestration examples.
+```
+
+---
+
+## Template Usage Notes
+
+### Naming Convention
+
+Workflow orchestration skills use compound names:
+- `{category}+{operation}` format
+- Examples:
+  - `feature+full-pipeline` - Full feature development pipeline
+  - `requirement+breakdown` - Requirement to feature breakdown
+  - `code+review-merge` - Code review and merge workflow
+
+### Section Order (v2 Cognitive Flow)
+
+MANDATORY: Sections must appear in this sequence:
+
+```yaml
+workflow_orchestration_skills:
+  section_order:
+    # CONTEXT
+    1: Purpose
+    2: Important Notes
+    # DECISION
+    3: Input Parameters
+    4: Definition of Ready (DoR)
+    # ACTION
+    5: Execution Flow Summary (DAG/Sub-agent)
+    6: Execution Procedure (Steps)
+    # VERIFY
+    7: Output Result
+    8: Definition of Done (DoD)
+    # REFERENCE
+    9: Registry (Task Types / Skill Mapping)
+    10: Error Handling
+    11: Templates
+    12: Examples
+```
+
+### Format Standards
+
+| Element | Format |
+|---------|--------|
+| Execution procedure | XML `<procedure>` with `<phase_N>` blocks |
+| Skill registry | Markdown table |
+| Data flow | YAML diagram |
+| Decision points | IF/THEN/ELSE in XML |
+| DoR/DoD | XML checkpoints |
+| Importance signals | Keywords (BLOCKING, CRITICAL, MANDATORY) |
+
+### Key Differences from Task Type Skills
+
+| Aspect | Task Type | Workflow Orchestration |
+|--------|-----------|------------------------|
+| Implements logic | Yes | No - coordinates other skills |
+| Produces artifacts | Directly | Aggregates from coordinated skills |
+| Execution unit | Single skill | Multiple skills in phases |
+| Error handling | Self-contained | Rollback across skills |