Workflow Library Usage Guide

How to discover, use, and customize workflows from CODITECT's comprehensive library.

---

Prerequisites

Before using CODITECT workflows, ensure you have:

• CODITECT framework installed
• Access to docs/workflows/ directory
• Basic understanding of workflow concepts

Verify workflow access:

ls docs/workflows/ | wc -l  # Should show 50+ files
cat docs/workflows/WORKFLOW-LIBRARY-INDEX.md | head -30

---

Overview

CODITECT includes 750+ pre-built workflows covering software development, business operations, research, and personal productivity. This guide explains how to find and execute workflows effectively.

Workflow Index: WORKFLOW-LIBRARY-INDEX.md

---

Quick Start

Step 1: Find a Workflow

# Search by keyword
grep -r "code review" docs/workflows/

# Browse the index
cat docs/workflows/WORKFLOW-LIBRARY-INDEX.md

# Search with context memory
/cxq "workflow for code review"

Step 2: Execute a Workflow

Most workflows are invoked through Claude Code conversation:

User: Execute the "Code Review Workflow" for src/api/

Claude: [Executes workflow steps automatically]

For command-based workflows:

/code-review src/api/
/deploy --environment staging
/security-scan --full

---

Workflow Categories

Software Development (100+ workflows)

Category	Workflows	Use For
Project Lifecycle	10	New project setup, sprints, releases
Code Quality	15	Reviews, refactoring, standards
Testing	12	Unit, integration, E2E, performance
DevOps	15	CI/CD, deployments, monitoring
Documentation	8	API docs, guides, changelogs

Location: 50-ESSENTIAL-WORKFLOWS.md

AI/ML & Data Engineering (50 workflows)

Category	Workflows	Use For
Model Training	10	Training pipelines, evaluation
Data Pipelines	12	ETL, data quality, transformation
MLOps	8	Model deployment, monitoring
Analytics	10	Dashboards, reporting, insights

Location: WORKFLOW-DEFINITIONS-AI-ML-DATA.md

Business Operations (150+ workflows)

Category	Workflows	Use For
Sales	50	Pipeline, leads, proposals
Marketing	25	Campaigns, content, analytics
Operations	50	Process optimization, automation
Finance	25	Budgeting, reporting, compliance

Locations:

• BUSINESS-SALES-WORKFLOWS.md
• BUSINESS-OPERATIONS-WORKFLOWS.md

---

Workflow Structure

All CODITECT workflows follow a standard structure:

workflow:
  name: "Workflow Name"
  id: "WF-CATEGORY-NNN"
  category: "category-name"

  description: |
    What this workflow accomplishes.

  triggers:
    - manual
    - scheduled: "0 9 * * 1"  # Cron format
    - event: "pull_request.opened"

  inputs:
    - name: target
      type: string
      required: true
      description: "Target for workflow"

  steps:
    - name: "Step 1"
      action: "action-type"
      params:
        key: value

    - name: "Step 2"
      action: "another-action"
      depends_on: "Step 1"

  outputs:
    - name: result
      type: object
      description: "Workflow output"

  quality_gates:
    - name: "Validation"
      condition: "result.status == 'success'"

---

Executing Workflows

Method 1: Natural Language

Simply describe what you want:

"Run the code review workflow on the authentication module"
"Execute security scan workflow for the entire codebase"
"Start the sprint planning workflow for Sprint 15"

Method 2: Slash Commands

Many workflows have associated commands:

# Code quality
/lint src/
/format --check
/typecheck

# Testing
/test unit
/test integration
/coverage

# Deployment
/deploy staging
/rollback production

# Documentation
/generate-docs api
/update-changelog

Method 3: Agent Invocation

For complex workflows, invoke specialized agents:

"Use code-reviewer agent to analyze the PR"
"Use security-auditor agent to run vulnerability assessment"
"Use devops-engineer agent to set up CI/CD pipeline"

---

Customizing Workflows

Override Default Parameters

# Default
/deploy staging

# With overrides
/deploy staging --skip-tests --notify slack

Create Workflow Variants

1. Copy existing workflow definition
2. Modify parameters for your use case
3. Save to docs/workflows/custom/

# custom/fast-deploy.yaml
extends: "WF-DEVOPS-001"
name: "Fast Deploy (Skip Tests)"
overrides:
  steps:
    - name: "Run Tests"
      skip: true

Chain Workflows

"Execute code review workflow, then if approved, run deployment workflow"

---

Workflow Discovery

By Domain

Domain	Index Section
Software Development	Essential Workflows
AI/ML	AI/ML & Data
Business	Business Operations
Research	Research & Intelligence
Personal	Personal & Lifestyle

By Task Type

Task	Recommended Workflow
Start new project	Project Initialization Workflow
Review code	Code Review Workflow
Deploy application	Deployment Pipeline Workflow
Fix security issue	Security Remediation Workflow
Write documentation	Documentation Generation Workflow
Plan sprint	Sprint Planning Workflow

By Keyword Search

# Search workflow files
grep -r "keyword" docs/workflows/*.md

# Search with context memory
/cxq "workflow" --limit 20

---

Best Practices

1. Start with Pre-built Workflows

Don't reinvent the wheel. Check the library first:

grep -r "your task" docs/workflows/

2. Use Quality Gates

All production workflows should include validation:

quality_gates:
  - name: "Tests Pass"
    condition: "test_results.passed == true"
  - name: "Coverage Met"
    condition: "coverage >= 80"

3. Document Custom Workflows

When creating custom workflows:

• Add YAML frontmatter for searchability
• Include clear descriptions
• Document all inputs/outputs
• Add examples

4. Version Control Workflows

Track workflow changes:

git add docs/workflows/custom/
git commit -m "feat(workflows): Add custom fast-deploy workflow"

---

Integration with Components

Workflows + Agents

Workflows can invoke specialized agents:

steps:
  - name: "Security Scan"
    agent: "security-auditor"
    params:
      scope: "full"

Workflows + Commands

Commands often wrap workflows:

# This command executes the deployment workflow
/deploy staging

Workflows + Skills

Skills provide reusable patterns used by workflows:

steps:
  - name: "Apply Pattern"
    skill: "production-patterns"
    pattern: "circuit-breaker"

---

Troubleshooting

Workflow Not Found

Problem: Searching for workflow returns no results Solution:

# Search across all workflow files
grep -ri "keyword" docs/workflows/

# Check workflow library index
grep "keyword" docs/workflows/WORKFLOW-LIBRARY-INDEX.md

Workflow Execution Error

Problem: Workflow fails during execution Solution: Check:

1. All prerequisites met
2. Required agents activated
3. Input parameters valid

Custom Workflow Not Loading

Problem: Custom workflow YAML not recognized Solution:

1. Verify YAML syntax: python -c "import yaml; yaml.safe_load(open('file.yaml'))"
2. Check file location: docs/workflows/custom/
3. Ensure proper frontmatter format

---

Related Documentation

• WORKFLOW-LIBRARY-INDEX.md - Complete workflow catalog
• COMPONENT-ACTIVATION-GUIDE.md - Activating components
• USER-BEST-PRACTICES.md - General best practices

---

Next Steps

After mastering workflow basics:

1. Browse: Workflow Library Index
2. Create: Custom workflows in docs/workflows/custom/
3. Integrate: Component Activation Guide
4. Explore: 50 Essential Workflows

---

Last Updated: 2025-12-28 Owner: AZ1.AI INC