overcut-playbooks

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

overcut-playbooks

★ 9 Open GitHub ↗

Overcut is an agentic SDLC orchestration platform that automates end-to-end software workflows across tools and repositories, using governed AI agents with built-in approvals, policies, and full auditability.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Overcut Playbooks

> Open-source collection of ready-to-use AI agent workflows for software development automation using [Overcut](https://overcut.ai).

## 🎯 What Are Playbooks?

Playbooks are pre-built, customizable workflows that use AI agents to automate complex software development tasks. Each playbook includes:

- **Workflow Definition** (`workflow.json`) - Import directly into Overcut
- **Step Prompts** (`step-*.md`) - Editable instructions for each workflow step
- **Documentation** (`README.md`) - Complete guide to understanding and customizing

## 🚀 Quick Start

### 1. Browse Playbooks

Explore the playbooks below to find workflows that match your needs.

### 2. Import to Overcut

1. Download the `workflow.json` file from any playbook folder
2. Go to Overcut Workflow Builder
3. Click "Import Workflow"
4. Upload the JSON file
5. Customize as needed

### 3. Customize with AI

Use AI to help you:

- Adjust prompts for your specific codebase
- Modify triggers and conditions
- Learn patterns to create new workflows

## 📚 Available Playbooks

### Planning & Requirements

- [Requirements Document Generation](./requirements-document-generation/) - Automatically generates comprehensive requirements documents from feature requests with codebase analysis and iterative review.
- [Technical Design Proposal](./technical-design-proposal/) - Generate comprehensive technical design documents from requirements.
- [Break Down Ticket](./break-down-ticket/) - Automatically decomposes large tickets into smaller, independently implementable sub-tickets with clear scope, acceptance criteria, and dependencies.

### Development & Implementation

- [Create PR from Design](./create-pr-from-design/) - Automatically creates implementation pull requests from approved design documents with phased implementation, real-time progress tracking, and comprehensive testing.

### Code Quality & Review

- [Code Review](./code-review/) - Automated comprehensive code review with inline comments and suggestions.
- [Fix Review Comments](./fix-review-comments/) - Automatically addresses code review feedback with structured implementation plans and real-time progress tracking.
- [Fix CI](./fix-ci/) - Automatically detects CI workflow failures on PR branches, analyzes error logs to identify root causes, applies code fixes, and commits the changes back to the branch.
- [Auto PR Description](./auto-pr-description/) - Automatically generates and updates pull request descriptions based on code changes, commits, and related issues while preserving user-written content.
- [Release PR Description](./release-pr-description/) - Generates release-focused PR descriptions that summarize features and functionality for PRs targeting the main branch, complementing Auto PR Description for release workflows.
- [Auto Root Cause Analysis](./auto-root-cause-analysis/) - Automatically analyze bugs and suggest fixes when issues are labeled.
- [Auto Changelog Reminder](./auto-changelog-reminder/) - Reminds developers to update changelog on PRs.
- [Auto Docs Update on Merge](./auto-docs-update-on-merge/) - Automatically updates documentation when PRs are merged.
- [Auto Update AGENTS.md](./auto-update-agents-md/) - Automatically generates or updates the AGENTS.md file based on repository structure and patterns. Runs on a schedule to keep documentation synchronized with the repository state. Works with any repository type.
- [Implement Documentation from Issue](./implement-docs-from-issue/) - Automatically implements documentation updates based on issues, analyzing product PRs and creating documentation pull requests following existing standards and structure.
- [Test Coverage Gap Analysis](./test-coverage-gap-analysis/) - Identifies test coverage gaps using targeted search strategies, validates against existing issues, and creates actionable issues for uncovered critical paths.

### Security

- [Remediate CVEs](./remediate-cves/) - Analyzes CVEs with context-aware risk assessment, evaluates multiple remediation strategies with trade-offs, and creates comprehensive implementation plans that automatically trigger PR creation.

### Collaboration

- [Automated Ticket Triage](./automated-ticket-triage/) - Automatically categorize and prioritize new issues.

### Migration & Refactoring

- [Migration Package](./migration-package/) - Complete multi-workflow system for migrating code between architectures or frameworks.

## 🎨 Customization Guide

### Editing Prompts

Each workflow step has a corresponding `.md` file with the prompt:

```
code-review/
├── workflow.json
├── README.md
├── prepare-review-plan.md  ← Edit this to customize this step
├── code-review.md          ← Edit this to customize this step
└── ...
```

**To customize:**

1. Edit the markdown file for the step you want to change
2. **Option A**: Copy the prompt and manually update in Overcut Workflow Builder
3. **Option B**: Ask AI to update the workflow.json file, and import the `workflow.json` file into Overcut.

### Working with AI

AI can help you:

- **Adapt prompts** to your codebase conventions
- **Learn patterns** from existing playbooks
- **Create new workflows** based on these examples
- **Troubleshoot** when workflows don't behave as expected

### Example AI Prompts to Try

**Editing existing workflows:**

```
- "I edited code-review.md to focus on security. Update workflow.json to match."
- "Change the prepare-review-plan.md prompt to emphasize API changes, then update the workflow."
```

**Creating new workflows:**

```
- "Adapt the code review workflow to focus on security issues"
- "Create a new workflow similar to root cause analysis but for performance issues"
- "Modify the design proposal workflow to include cost estimates"
- "Modify the design proposal workflow to include cost estimates"
```

### Understanding Prompt Files

**IMPORTANT**: Prompt filenames match step IDs in `workflow.json`

This naming convention enables AI-assisted workflow updates:

- When you edit a prompt file, AI can automatically update the workflow
- Bidirectional editing: change prompt → update workflow, or vice versa

**Example**:

```json
// In workflow.json
"steps": [{
  "id": "code-review",  // ← Step ID
  "instruction": "..."  // ← Content from code-review.md
}]
```

**Prompt file must be**: `code-review.md` (not `step-1-code-review.md`)

## 🏗️ Workflow Structure

Each playbook folder contains:

```
playbook-name/
├── workflow.json          # Import this into Overcut
├── README.md              # Documentation and usage guide
├── step-id-name.md        # Prompt for step (filename = step ID)
├── another-step-id.md     # Each prompt file matches its step ID
├── special-agents/        # (Optional) Specialized agent instructions
│   └── agent-name.md      # Instructions for configuring custom agents
└── ...                    # More steps as needed
```

**Important**: Prompt filenames must match the step IDs in `workflow.json`. This enables AI agents to automatically update workflows when you edit prompts.

The prompt files are a human readable duplication of the workflow.json file. You can edit the prompt files to customize the workflow, but eventually you will need to update the `workflow.json` file before importing it into Overcut.

### special Agents Folder

Some workflows require **specialized agents** with domain-specific expertise beyond generic developer roles. When a workflow needs agents like "Security Engineer" (for CVE analysis) or "Database Architect" (for schema migrations), you'll find detailed configuration instructions in the `special-agents/` folder.

These instructions help you create properly configured custom agents in Overcut with the right expertise, decision frameworks, and behavioral guidelines for the workflow's specific needs.

### Understanding workflow.json

The workflow file includes:

- **Trigger configuration** - What starts the workflow
- **Step definitions** - Each step's action and parameters
- **Flow logic** - How steps connect and conditions
- **Agent references** - Which AI agents are used

**Note**: Agent IDs in these files are examples. When importing, you'll need to map them to your Overcut agents.

## 🤝 Contributing

We welcome contributions!

### Adding New Playbooks

1. Create a new folder with your playbook name
2. Include `workflow.json`, `README.md`, and step `.md` files
3. Follow the existing structure and README template
4. Submit a PR with your playbook

### Improving Existing Playbooks

- Found a better prompt? Submit improvements!
- Discovered edge cases? Add documentation!
- Built variations? Share them!

See [CONTRIBUTING.md](./CONTRIBUTING.md) for detailed guidelines.

## 📖 Learning Resources

Below are some key concepts to understand about Overcut Workflows.
Read our [documentation](https://docs.overcut.ai) for more information.

### Understanding Overcut Workflows

- **Step Isolation**: Each step starts fresh - pass data explicitly
- **Agent Selection**: Choose the right agent personas for each task
- **Output References**: Use `{{outputs.step-id.field}}` syntax
- **Coordinator Patterns**: Learn when to use multi-agent coordination

### Key Concepts

- **Triggers**: Events or commands that start workflows
- **Steps**: Individual tasks (git operations, agent runs, agent sessions)
- **Agents**: AI personas with different specializations
- **Flow**: Connections between steps with optional conditions

## 🔗 Links

- [Overcut Platform](https://overcut.ai)
- [Documentation](https://docs.overcut.ai)

## 📄 License

MIT License - See [LICENSE](./LICENSE) for details.

---

**Built with ❤️ by the Overcut team**

_Have questions? Open an issue!_

overcut-playbooks

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README