Design, review, and improve agent workflows & agent using SSOT, SRP, Fail Fast principles. Supports Prompt Chaining, Parallelization, Orchestrator-Workers patterns.
A comprehensive guide for designing, reviewing, and improving agent workflows based on proven design principles.
ā See references/design-principles.md for details
| Tier | Principles | Focus |
|---|---|---|
| Tier 1: Essential | SSOT, SRP, Simplicity First, Fail Fast, Iterative Refinement, Feedback Loop | Must-have for any workflow |
| Tier 2: Quality | Transparency, Gate/Checkpoint, DRY, ISP, Idempotency | Recommended for production |
| Tier 3: Scale | Human-in-the-Loop, KISS, Loose Coupling, Graceful Degradation | Advanced patterns |
Key insight:
ā See references/workflow-patterns.md for details
What's the nature of the task?
āā Sequential processing needed āāā Prompt Chaining
āā Multiple independent tasks āāāāā Parallelization
āā Dynamic task decomposition āāāāā Orchestrator-Workers
āā Until quality criteria met āāāāā Evaluator-Optimizer
āā Processing varies by input āāāāā Routing
| Pattern | Use Case | Iterative Level |
|---|---|---|
| Prompt Chaining | Sequential with validation | āāā |
| Routing | Classify ā route to specialists | āā |
| Parallelization | Execute independent tasks together | āā |
| Orchestrator-Workers | Dynamic decomposition ā workers | āāā |
| Evaluator-Optimizer | Generate ā evaluate ā improve loop | āāāāā |
## Workflow Design Interview
1. **Goal**: What do you want to achieve?
2. **Task Decomposition**: What subtasks can this be broken into?
3. **Dependencies**: Are there ordering dependencies between tasks?
4. **Parallelism**: Which tasks can run independently?
5. **Quality Criteria**: What defines success/failure?
6. **Error Handling**: How should failures be handled?
Choose the optimal pattern based on requirements:
| Condition | Recommended Pattern |
|---|---|
| Tasks have clear ordering | Prompt Chaining |
| Tasks are independent | Parallelization |
| Number of tasks is dynamic | Orchestrator-Workers |
| Repeat until quality criteria met | Evaluator-Optimizer |
| Processing varies by input type | Routing |
Visualize with Mermaid:
graph TD
A[Start] --> B{Task Classification}
B -->|Type A| C[Agent 1]
B -->|Type B| D[Agent 2]
C --> E[Reviewer]
D --> E
E -->|OK| F[End]
E -->|NG| G[Feedback]
G --> C
G --> D
Validate design against principles (use review checklist)
Build small ā verify ā get feedback ā improve
ā See references/review-checklist.md for complete checklist (includes anti-patterns)
- [ ] Is each agent focused on a single responsibility? (SRP)
- [ ] Can errors be detected and stopped immediately? (Fail Fast)
- [ ] Is it divided into small steps? (Iterative)
- [ ] Can results be verified at each step? (Feedback Loop)
- [ ] Are related files (references, scripts) simple and minimal? (DRY)
ā See references/context-engineering.md for details
For long-running agents, manage context as a finite resource:
| Technique | When to Use |
|---|---|
| Compaction | Context window 70%+ full |
| Structured Note-taking | Multi-hour tasks with milestones |
| Sub-agent Architectures | Complex research, parallel exploration |
| Just-in-Time Retrieval | Large codebases, dynamic data |
Key insight:
Automatically generate workflow directory structures.
# Basic workflow
python scripts/scaffold_workflow.py my-workflow
# Specify pattern
python scripts/scaffold_workflow.py code-review --pattern evaluator-optimizer
# Specify output path
python scripts/scaffold_workflow.py data-pipeline --pattern orchestrator-workers --path ./projects
# List available patterns
python scripts/scaffold_workflow.py --list-patterns
| Pattern | Description |
|---|---|
basic |
Basic workflow structure |
prompt-chaining |
Sequential processing pattern |
parallelization |
Parallel processing pattern |
orchestrator-workers |
Orchestrator + workers pattern |
evaluator-optimizer |
Evaluation-improvement loop |
routing |
Routing pattern |
my-workflow/
āāā Agent.md # Workflow overview & agent list
āāā README.md # Usage guide
āāā .github/
ā āāā copilot-instructions.md # GitHub Copilot instructions
ā āāā instructions/ # File-pattern-specific rules
ā āāā workflow.instructions.md
ā āāā agents.instructions.md
ā āāā prompts.instructions.md
āāā agents/ # Agent definitions
āāā prompts/ # Prompt templates
ā āāā system_prompt.md
ā āāā task_prompt.md
ā āāā error_handling_prompt.md
āāā docs/ # Design documentation
ā āāā design.md
ā āāā review_notes.md
āāā config/ # Configuration files
| File | Content |
|---|---|
| design-principles.md | Design principles (Tier 1-3) + ACI |
| workflow-patterns.md | 5 workflow patterns with examples |
| review-checklist.md | Full checklist + anti-patterns |
| context-engineering.md | Context management for long tasks |
| scaffold_workflow.py | Directory structure generator |