Workpackage System Overview

The Sigao AI DevKit's workpackage system provides a powerful automation framework for executing complex development tasks using AI assistance. This system allows you to define structured sets of tasks that Claude (Anthropic's AI assistant) can execute sequentially, with built-in validation, testing, and dependency management.

What is a Workpackage?

A workpackage is a JSON-formatted specification that defines:

• Tasks: Individual units of work with clear descriptions and acceptance criteria
• Dependencies: Relationships between workpackages for ordered execution
• Context: Shared information accessible across all tasks
• Deliverables: Expected output files and artifacts
• Tests: Automated validation to ensure task completion

Key Features

System Architecture

The workpackage system consists of several key components:

1. Validator: Ensures workpackage JSON files conform to the required schema
2. Orchestrator: Manages execution flow and dependency resolution
3. Claude Interface: Handles communication with the AI assistant
4. Context Manager: Maintains state and shares information between tasks
5. UI System: Provides interactive selection and progress visualization

Use Cases

Workpackages are ideal for:

• Project Scaffolding: Setting up new projects with consistent structure
• Feature Implementation: Breaking down complex features into manageable tasks
• Code Refactoring: Systematic code improvements across multiple files
• Documentation Generation: Creating comprehensive documentation sets
• Testing Automation: Generating test suites and validation scripts

Quick Example

Here's a simple workpackage that creates a "Hello World" application:

[
  {
    "id": "WP-01-HELLO",
    "title": "Hello World Setup",
    "depends_on": [],
    "tasks": [
      {
        "task": "Create a hello.js file that prints 'Hello from Workpackages!'",
        "acceptance": "File exists and contains the message",
        "test": "node hello.js | grep -q 'Hello from Workpackages!'"
      }
    ],
    "deliverables": ["hello.js"],
    "agent": "claude",
    "status": "ready"
  }
]

Getting Started

To start using workpackages:

1. Install and configure the Sigao CLI and Claude
2. Learn the basics of creating and running workpackages
3. Explore examples for common use cases
4. Troubleshoot issues if you encounter problems

Navigation

Additional Resources

• User Guide - Comprehensive usage documentation
• Developer Guide - Extending and customizing the system
• API Reference - Complete API documentation
• Troubleshooting - Common issues and solutions