Skip to content

pvginkel/AIWorkflow

Repository files navigation

AI Workflow

A reusable scaffolding for running a slice-based, multi-agent development workflow with Claude Code.

This repository is a template, not a library. Copy its contents into a real project and fill in the marked sections. Jinja2 syntax ({{ variables }} and {% block %}…{% endblock %}) marks the places that need customization — you do not need to actually run Jinja2; the syntax is only a visual indicator of what is project-specific.

What's in here

  • orchestrator/ — everything that gets copied to the monorepo root. The orchestrator session's CLAUDE.md, the slice-management skills (run-slice, write-slice, triage, arch-design, ux-design, quality-improver, quality-issue-finder, refactor-audit) and the major/minor change-workflow commands, all the agentsarch-design, slice-verifier, and the four dev agents (plan-writer, plan-reviewer, code-writer, code-reviewer) — root scaffolding (pyproject.toml, pnpm-workspace.yaml, .gitignore, .codehealthignore), and orchestration scripts (scripts/build-all.py, scripts/regenerate-openapi.py). Agents live here, not under project/, because Claude Code registers project agents only from the git root (see ADOPTING.md).
  • project/ — content for each per-subproject Claude Code session (backend, frontend, portal, etc.): a per-project CLAUDE.md (and the project-authored docs/conventions.md it points at). These load hierarchically from each subproject directory, which is how a dev agent picks up its subproject's conventions.
  • tools/ai_workflow/ — runtime scripts the orchestrator depends on: claude_session.py (session manager for dispatching dev agents), codex_exec.py (wrapper for invoking Codex — optional, only used by /ux-design when that path is chosen), send_message.py (push-notification helper).
  • tools/code_health/ — code-health grader (Python + a TypeScript cognitive-complexity sidecar). Wired as a Poetry script (code-health) by orchestrator/pyproject.toml. Used by the refactor-audit and quality-issue-finder skills.
  • .agents/skills/frontend-ux-designer/ — a Codex skill definition (prompt + UX review checklist + design-doc template) consumed by /ux-design if you invoke it via Codex. Only needed if you go down that path; safe to delete if you dispatch UX work as a Claude Code subagent instead.

Tooling expectations

  • Claude Code — required. The whole workflow assumes the claude CLI is available and dispatches dev agents through it.
  • Codex (OpenAI) — optional. Only the /ux-design skill's "Codex" invocation option uses it, via tools/ai_workflow/codex_exec.py. The skill ships with a Claude Code subagent alternative; if you prefer that, you can delete codex_exec.py and .agents/.
  • Python 3.11+, pnpm, Poetry — the orchestration scripts and the code-health grader depend on these.

How to use it

  • Read EXAMPLE.md for a fully-rendered example of what one CLAUDE.md looks like after the placeholders are filled in. This is the quickest way to see what the template produces.
  • Read ADOPTING.md for how to copy this template into a new project and fill in the variables.
  • Read WRITING_GUIDE.md for the rules that keep these artifacts maintainable over time — where different kinds of content belong, what to duplicate (nothing), and how to structure agent definitions and skills.

A note on the Jinja syntax

The template files use Jinja2-style syntax ({{ variables }} and {% block %}…{% endblock %}) as a visual marker for the places that need customization. The template is not actually rendered by Jinja. You are expected to do a find-and-replace pass with your project's values (variables) and replace each {% block %}…{% endblock %} with prose specific to your codebase. Treating the placeholders as syntax hints rather than as runtime templating means you can edit files in any tool, run them through any preprocessor, or skip the substitution entirely and just edit by hand. EXAMPLE.md shows the before-and-after.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors