Skip to content

jumppad-labs/iw

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Implementation Workflow

A structured workflow for Claude Code that takes a plan and research-first approach to implementing features. This workflow provides skills, commands, and hooks to guide implementation from initial planning through to PR creation.

Overview

The Implementation Workflow is a comprehensive set of Claude Code skills and commands that help you:

  • Plan systematically - Create detailed implementation plans with research, code snippets, and clear phases
  • Execute methodically - Follow plans with incremental progress tracking and user confirmation
  • Learn continuously - Capture corrections and learnings for future reference
  • Integrate seamlessly - Work with GitHub issues, PRs, and git workflows

What Gets Installed

Skills (13 total)

Implementation Workflow Skills

  • iw-planner - Create detailed implementation plans through interactive research process
  • iw-executor - Execute implementation plans with phase-based commits and tracking
  • iw-workflow - Workflow guidance and documentation structure explanation
  • iw-learnings - Search past learnings and corrections from previous work
  • iw-init - Initialize .docs directory structure for plans and knowledge
  • iw-github-issue-reader - Load comprehensive GitHub issue information
  • iw-github-pr-creator - Create GitHub pull requests with plan summaries
  • iw-git-workflow - Manage git operations with worktrees and phase commits
  • iw-research-planner - Define research scope and create structured research plans
  • iw-research-executor - Gather information and automatically generate comprehensive reports
  • iw-research-synthesizer - Generate comprehensive reports (auto-invoked by executor)

Development Guidelines

  • go-dev-guidelines - Go development patterns and TDD workflow (language-specific)
  • skill-creator - Guide for creating new skills

Slash Commands (6 total)

Implementation Workflow Commands

  • /iw-plan - Create detailed implementation plan
  • /iw-implement - Execute implementation plan
  • /iw-help - Show workflow guidance and available commands
  • /iw-install - Manage workflow installation (install, update, uninstall)
  • /iw-research-plan - Create new research plan with questions and scope
  • /iw-research-execute - Gather information and generate comprehensive report

Hooks (6 total)

  • load_workflow.py - Cross-platform session start hook showing documentation structure
  • list_skills.py - Cross-platform hook to list available skills at session start
  • check_workflow_version.py - Cross-platform hook to check for workflow updates
  • load_workflow.sh - Deprecated bash version (kept for backward compatibility)
  • list_skills.sh - Deprecated bash version (kept for backward compatibility)
  • check_workflow_version.sh - Deprecated bash version (kept for backward compatibility)

Support Files

  • Python scripts for plan management, task tracking, and GitHub integration
  • Template files for plan structure (plan, tasks, context, research)
  • Reference documentation for Go development guidelines

Quick Start

Cross-Platform Installation

The Implementation Workflow supports Windows, macOS, and Linux.

Recommended: Python Bootstrap (All Platforms)

# Download bootstrap script
curl -sSL https://raw.githubusercontent.com/jumppad-labs/iw/main/bootstrap.py -o bootstrap.py

# Run bootstrap
python3 bootstrap.py

Alternative: Bash Bootstrap (macOS/Linux Only)

# For macOS/Linux users who prefer bash
curl -sSL https://raw.githubusercontent.com/jumppad-labs/iw/main/bootstrap.sh | bash

The bootstrap will:

  1. Prompt you to choose project-level or user-level installation
  2. Download and set up the iw-install skill
  3. Provide instructions for completing installation

After bootstrap completes, restart Claude Code and run:

/iw-install

Platform-Specific Notes

Windows:

  • Requires Python 3.7+ and Git for Windows
  • Use python3 bootstrap.py (bootstrap.sh won't work without WSL)
  • PowerShell, Command Prompt, and Git Bash all supported

macOS/Linux:

  • Both bootstrap.py and bootstrap.sh work
  • Requires Python 3.7+ and git
  • Python version recommended for consistency

Installation Locations

You can install the workflow in two locations:

Project-Level (Recommended for team workflows)

Install to .claude/ in your project root:

  • Committed to version control
  • Shared with team members
  • Project-specific configuration

User-Level (Recommended for personal use)

Install to ~/.claude/:

  • Available in all projects
  • Personal configuration
  • Not committed to repos

Usage

Planning a Feature

For complex features or tasks that require research and structured planning:

/iw-plan 123

or

/iw-plan Add user authentication system

This will:

  1. Load GitHub issue context (if issue number provided)
  2. Search past learnings for relevant knowledge
  3. Launch parallel research agents to explore the codebase
  4. Guide you through context gathering and design decisions
  5. Create structured plan files in .docs/issues/<number>/ or .docs/adhoc/<name>/

Implementing a Plan

After creating and reviewing a plan:

/iw-implement 123

or

/iw-implement .docs/issues/123/

This will:

  1. Load the plan files (plan.md, tasks.md, context.md, research.md)
  2. Create isolated worktree for implementation
  3. Execute tasks phase by phase
  4. Create commits after each phase
  5. Track progress in tasks.md
  6. Confirm with you at key milestones

Getting Help

/iw-help

Shows workflow guidance, documentation structure, and available commands.

Research Workflow

For conducting systematic research on technical topics, academic papers, or code implementations. Now with Obsidian vault integration for seamless personal knowledge management.

Overview

The research workflow supports flexible storage locations:

  • .docs/research/ - Standard project location (default)
  • Obsidian vault - Auto-detected for personal knowledge base
  • Custom paths - Any location you specify

Research happens in a temporary workspace, final report saved to your chosen location, and intermediate files are automatically cleaned up.

1. Create Research Plan

/iw-research-plan

This will:

  1. Detect Obsidian vault (if configured) and offer as workspace option
  2. Ask about your research topic and questions
  3. Help define 3-5 specific research questions
  4. Identify source types needed (papers, code repos, docs, articles)
  5. Define scope boundaries (included/excluded topics)
  6. Create research plan in chosen workspace location

2. Execute Research and Generate Report

/iw-research-execute

This will:

  1. Load your research plan
  2. Gather from multiple source types:
    • Academic papers via WebSearch (Google Scholar, arXiv, etc.)
    • Code repositories via GitHub exploration
    • Technical documentation via official docs
    • Blog posts and articles
  3. Organize findings by theme in findings.md
  4. Track all sources in sources.md
  5. Automatically generate comprehensive report:
    • Analyze all gathered findings
    • Generate executive summary (2-3 paragraphs)
    • Organize key findings by theme
    • Provide detailed analysis for each research question
    • Include source references
    • Add recommendations and next steps
    • Create research-report.md in Obsidian-compatible markdown

Output: Comprehensive research report with:

  • Executive summary
  • Key findings organized by theme
  • Detailed analysis with evidence
  • Simple source citations
  • Recommendations

Obsidian Integration

If you have the obsidian-local-api skill configured:

  1. Automatic vault detection:

    • Skill detects your Obsidian vault automatically
    • Offers vault root as workspace option
    • Seamless integration with your knowledge base
  2. Live preview during research:

    • Work in vault root for live Obsidian preview
    • See links and graph view while researching
    • Leverage Obsidian features during work
  3. Organized final storage:

    • Choose final report location (e.g., Research/ folder)
    • Intermediate files auto-cleaned
    • Only final report remains in vault

Setup:

  1. Install Obsidian Local REST API plugin
  2. Configure via obsidian-local-api skill
  3. Start research with /iw-research-plan
  4. Select Obsidian vault when prompted

Example workflow:

/iw-research-plan
# → Choose "Obsidian Vault Root" as workspace
# → Conduct research (files visible in Obsidian)
/iw-research-execute
# → Gather findings and sources
# → Final prompt: "Save report to Research/ folder"
# → Intermediate files auto-cleaned
# → Final report at: vault/Research/my-topic-report.md

Workflow Overview

The typical workflow for a planned feature:

  1. Plan: /iw-plan <issue-number> creates detailed implementation plan
  2. Review: Review plan files, request changes if needed
  3. Implement: /iw-implement <issue-number> executes the plan
  4. Verify: Confirm after each phase, run tests
  5. Complete: Automatic PR creation and worktree cleanup

Requirements

Core Requirements

  • Claude Code (latest version)
  • Git (for version control operations)
    • Git for Windows on Windows
    • Standard git package on macOS/Linux
  • Python 3.7+ (for helper scripts and installation)
    • From python.org or Microsoft Store on Windows
    • Pre-installed or via package manager on macOS/Linux

Optional Requirements

  • GitHub CLI (gh) - For GitHub issue and PR operations
  • jq - For JSON processing in scripts

Required for Language-Specific Skills

  • Go 1.21+ - If using go-dev-guidelines skill

Platform Support

  • Windows 10/11 - Fully supported (PowerShell, Command Prompt, Git Bash)
  • macOS - Fully supported
  • Linux - Fully supported

Updating the Workflow

Via Install Command

If you used the bootstrap installation:

/iw-install --update

This fetches the latest version from GitHub and overwrites existing files.

Manual Update

Re-run the bootstrap command or manual installation steps to get the latest version.

Uninstalling

Via Install Command

/iw-install --uninstall

Manual Uninstall

Remove the installed directories:

Project-level:

rm -rf .claude/skills/iw-*
rm -rf .claude/skills/go-dev-guidelines
rm -rf .claude/skills/skill-creator
rm -f .claude/commands/iw-*.md
rm -f .claude/hooks/load_workflow.sh
rm -f .claude/hooks/list_skills.sh

User-level:

rm -rf ~/.claude/skills/iw-*
rm -rf ~/.claude/skills/go-dev-guidelines
rm -rf ~/.claude/skills/skill-creator
rm -f ~/.claude/commands/iw-*.md
rm -f ~/.claude/hooks/load_workflow.sh
rm -f ~/.claude/hooks/list_skills.sh

Documentation Structure

The workflow creates a structured documentation approach:

.docs/
├── issues/              # Issue-based implementation plans
│   └── <number>/
│       ├── <number>-plan.md       # Implementation plan
│       ├── <number>-tasks.md      # Task checklist
│       ├── <number>-context.md    # Quick reference
│       └── <number>-research.md   # Research notes
├── adhoc/               # Ad-hoc plans not tied to issues
│   └── <name>/
│       └── (same structure)
└── knowledge/           # Institutional knowledge
    ├── learnings/       # Corrections and discoveries
    ├── architecture/    # Architecture documentation
    └── gotchas/         # Known issues and workarounds

Customization

Adding Language-Specific Guidelines

Create additional language-specific guideline skills following the pattern of go-dev-guidelines:

  1. Create .claude/skills/<language>-guidelines/SKILL.md
  2. Document coding standards, testing patterns, architecture patterns
  3. Reference from iw-planner and iw-executor skills

Adding Custom Skills

Use the skill-creator skill to create new custom skills.

Troubleshooting

Skills Not Loading

  1. Verify files are in correct location (.claude/skills/)
  2. Check SKILL.md has proper YAML frontmatter
  3. Restart Claude Code session

Scripts Not Executing

  1. Ensure Python 3.7+ is installed
  2. Check scripts are in scripts/ subdirectory of skill
  3. Verify script permissions (should be readable)

Hooks Not Running

  1. Unix/macOS: Check bash hooks are executable: chmod +x .claude/hooks/*.sh
  2. Windows: Ensure Python hooks (.py files) are present in .claude/hooks/
  3. All platforms: Verify hooks are in correct location
  4. Check hook configuration in settings
  5. Restart Claude Code to reload hooks

Windows-Specific Issues

Unicode characters not displaying:

  • Use Windows Terminal or PowerShell 7+ for better Unicode support
  • Older Command Prompt may show fallback characters
  • Scripts automatically handle encoding

Python scripts not executing:

  • Verify Python 3.7+ is installed: python3 --version
  • Ensure Python is in PATH
  • Use python3 script.py instead of ./script.py

Contributing

Contributions are welcome! Areas for contribution:

  • Additional language-specific guidelines skills (Python, TypeScript, Rust, etc.)
  • Enhanced GitHub integration features
  • Additional helper scripts for common tasks
  • Documentation improvements

License

Apache 2 - See LICENSE file for details

Support

For issues, questions, or feedback:

  • Open an issue on GitHub
  • Check existing issues for similar problems
  • Review workflow documentation in skills

Generated with Claude Code Implementation Workflow

About

Claude Code Implementation Workflow

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •