graflow-workflow

Graflow Workflow Builder

Build executable task graphs in Python using a structured 3-phase approach.

Workflow: Plan -> Implement -> Review

Phase 1: Plan

Goal: Clarify requirements, create a design document, and get user approval through iterative feedback.

Steps:

Step 1: Requirements Gathering

Ask the user clarifying questions about the workflow:

• What is the workflow's purpose?
• What are the input sources and output destinations?
• Which tasks need to run sequentially vs. in parallel?
• Is LLM integration needed?
• Are there any dynamic/conditional branching requirements?

Step 2: Create Design Document

Create a design document (workflow_design.md) with:

• Workflow overview and purpose
• Task definitions (name, responsibility, inputs/outputs)
• Task graph structure (ASCII diagram)
• Channel data flow
• Error handling strategy

Design Document Template:

# Workflow Design: {workflow_name}

## Overview
{Brief description of what this workflow accomplishes}

## Tasks

| Task ID | Responsibility | Inputs | Outputs |
|---------|---------------|--------|---------|
| task_a  | ...           | ...    | ...     |

## Task Graph

source >> (transform_a | transform_b) >> sink

## Channel Data Flow
- `config`: Set by setup, used by all tasks
- `results`: Accumulated by each task

## Error Handling
- {Strategy: fail-fast, best-effort, retry, etc.}

Step 3: Present Design to User

Present the design document to the user with a clear summary:

• Show the task graph diagram
• Highlight key design decisions
• Ask explicitly: "Does this design meet your requirements? Please provide feedback if any changes are needed."

Step 4: Iterate on Feedback

If the user provides feedback:

1. Update workflow_design.md with the requested changes
2. Summarize the changes made
3. Re-present the updated design
4. Repeat until the user is satisfied

Step 5: Confirm Design Approval

Before proceeding to implementation:

• Ask the user to confirm: "Is this design approved? If yes, I'll proceed to implementation."
• Only move to Phase 2 after explicit approval