Overview

Custom workflows in Assembly allow you to create structured templates for AI-assisted tasks. When users start a new session with your workflow, Assembly’s AI assistant guides them through your defined process, maintaining context and providing consistent guidance throughout the interaction.

Workflow Structure

Every custom workflow consists of these essential components:

Core Components

  • Workflow Name
  • Description
  • Suggested Inputs
  • Process Guidelines
  • Output Requirements

Optional Elements

  • Start Messages
  • Context Files
  • Templates
  • Example Outputs

Creating a Workflow

Step 1: Planning Your Workflow

Before creating a workflow, gather these key details:

  1. Purpose and Scope

    • Clear objective of the workflow
    • Target users and use cases
    • Expected outcomes
  2. Required Resources

    • Necessary documentation
    • Code repositories
    • Reference materials
    • Example outputs
  3. Process Steps

    • Key stages and checkpoints
    • Decision points
    • Validation criteria

Step 2: Documenting the Workflow

Navigate to the Assembly Workflows tab (https://app.factory.ai/workflows/create) and include:

  1. Workflow Name and Description

    • Choose a clear, descriptive name
    • Write a concise (~10 words) description
    • Highlight key benefits or use cases
  2. Suggested Inputs

    ### Suggested Inputs
    
    Required:
    
    - [Input 1]: Description and format
    - [Input 2]: Description and format
    
    Optional:
    
    - [Input 3]: Additional helpful resources
    
  3. Process Guidelines

    ### Process Guidelines
    
    1. Stage 1: [Name]
    
       - Step-by-step instructions
       - Decision criteria
       - Expected outcomes
    
    2. Stage 2: [Name]
       - Detailed steps
       - Validation points
    
  4. Output Requirements

    ### Output Requirements
    
    Deliverables:
    
    1. [Output 1]
    
       - Format specifications
       - Quality criteria
       - Validation checklist
    
    2. [Output 2]
       - Technical requirements
       - Review guidelines
    

Step 3: Adding Context

1

Repository Context

Use the codebase explorer to link relevant repositories:

  • Main codebase
  • Documentation repos
  • Example implementations
2

Documentation Context

Upload supporting documents:

  • README files
  • Contributing guides
  • Configuration files
  • Style guides
3

Template Context

Include any templates:

  • Code templates
  • Document templates
  • Checklists

Step 4: Creating the Start Message

Craft a welcoming start message:

👋 Welcome to [Workflow Name]!

This workflow will help you [brief description of purpose].

To get started, please provide:

- [Required Input 1]
- [Required Input 2]

Optional but helpful:

- [Optional Input 1]
- [Optional Input 2]

Ready to begin? Let me know when you have these ready! ✨

Best Practices

1. Clarity and Structure

  • Use clear, consistent terminology
  • Break complex processes into manageable steps
  • Include examples where helpful
  • Define clear success criteria

2. Flexibility and Adaptability

  • Allow for variations in process
  • Include optional steps or alternatives
  • Provide decision-making guidance
  • Enable customization within guidelines

3. Context Management

  • Start with essential context
  • Include relevant documentation
  • Link to external resources
  • Maintain context boundaries

4. User Experience

  • Write clear instructions
  • Use engaging language
  • Include progress indicators
  • Provide helpful examples

Testing Your Workflow

Before publishing:

  1. Dry Run

    • Test the workflow yourself
    • Follow each step
    • Verify outputs
    • Check context loading
  2. Peer Review

    • Share with team members
    • Gather feedback
    • Test edge cases
    • Verify clarity
  3. Refinement

    • Incorporate feedback
    • Clarify instructions
    • Add missing context
    • Optimize steps

Next Steps

After creating your workflow:

  1. Share with your team
  2. Gather usage feedback
  3. Iterate and improve
  4. Document learnings

Explore Workflow Types

Discover different types of workflows you can create