Worker is a repo-agnostic agentic workflow skeleton for consistent delivery across roles. It provides named agents, dependency-aware workflows, and documentation rules so teams can plan, implement, review, and ship changes with a repeatable process.
What It Solves
- Consistent sequencing across planning, implementation, review, QA, docs, commit, and push.
- Clear role separation with guardrails to prevent role mixing.
- Repeatable workflows encoded in
agents/workflows/. - Centralized rules and checklists under
docs/agentRules/.
Start Here
Agents.mdfor a quick reference geared toward AI agents.docs/README.mdfor the documentation index.docs/agentRules/README.mdfor enforceable rules and checklists.docs/agents/howToUseAgents.mdas the primary guide for workflows in chat or terminal.docs/agents/usingAgentsInChat.mdfor chat-first workflow guidance.docs/agents/usingAgentsInTerminal.mdfor terminal-first workflow guidance.docs/agents/overview.mdfor where agent configs live.agents/workflows/as the source of truth for workflow definitions.
Workflow Guide
- Delivery flow for code changes and feature delivery.
- Product flow for research, PRD updates, and sprint planning.
- Feature breakdown flow for requirements, epics, stories, and tasks.
- Agile delivery flow for end-to-end work from requirements to delivery.
- Tech debt flow for refactors, stabilization, and cleanup.
- Research spike flow for time-boxed exploration and recommendations.
How It’s Used
- For chat-based use, follow
docs/agents/howToUseAgents.mdanddocs/agents/usingAgentsInChat.md. - For terminal-based use, follow
docs/agents/howToUseAgents.mdand use the runner scripts underscripts/agents/to scaffold steps. - For DAG scheduling details and status gating, see
docs/agents/dagScheduler.md.
AI Usage Paths
- Chat/GUI tools: Use
docs/agents/usingAgentsInChat.mdas the primary guide. It covers role sequencing, flow triggers, and how to pass outputs between steps. Cursor users should also review.cursor/rules/for the loaded workflow and role rules. - Terminal users: Use
docs/agents/usingAgentsInTerminal.mdas the primary guide. It explains how to run workflow scripts inscripts/agents/and complete the generated step files in order.
Rules You Must Follow
docs/agentRules/workflowRules.mdfor planning, review, and summaries.docs/agentRules/commitRules.mdfor commit format and pre-commit checks.docs/agentRules/documentationRules.mdanddocs/agentRules/noCodeInDocsRule.mdfor docs constraints.docs/agentRules/prioritizationRules.mdfor Next Up vs Backlog decisions.docs/agentRules/testingRules.mdfor testing requirements.docs/agentRules/codingStandards.mdfor style, naming, and KDoc requirements.docs/agentRules/architectureRules.mdfor architecture boundaries.docs/agentRules/thoughtfulCollaboration.mdfor critical thinking and collaboration.
Documentation Structure
docs/architecture/for system overview, constraints, and decisions.docs/product/for PRD, feature list, and roadmap.docs/quality/for test strategy and QA checklist.docs/release/for release notes and versioning policy.docs/onboarding/for setup and conventions.docs/tasks/for work boards and work plans.
Relationship Diagram
flowchart TD
README[README.md] --> AgentsQuick[Agents.md]
README --> DocsIndex[docs/README.md]
README --> CursorRules[.cursor/rules/]
README --> FirebenderRules[.firebender/rules/]
DocsIndex --> AgentRules[docs/agentRules/]
DocsIndex --> AgentGuides[docs/agents/]
DocsIndex --> WorkBoard[docs/tasks/]
AgentRules --> CommitRules[docs/agentRules/commitRules.md]
AgentRules --> DocRules[docs/agentRules/documentationRules.md]
AgentGuides --> HowTo[docs/agents/howToUseAgents.md]
AgentGuides --> WorkflowsGuide[docs/agents/workFlows.md]
Registry[agents/registry.yaml] --> Profiles[agents/profiles/]
Registry --> Workflows[agents/workflows/]
WorkflowsGuide --> Workflows
Scripts[ scripts/ ] --> HookDocs[scripts/README.md]
HookDocs --> Hooks[scripts/*-hook.sh]
Scripts --> Runner[scripts/agents/]
Repository Layout
agents/for registry, profiles, prompts, workflows, and memory..cursor/for Cursor rules..firebender/for Firebender agent definitions and rules.scripts/agents/for runner scripts and wrappers.docs/for documentation, including agent rules and how-to guides.tests/agents/for agent tests and evals.
be sure to add IDE settings from gitignore so taht they are not committed especially .cursor/ .firebender/
Enhancements
- Define a branching strategy (including whether to use branch-per-story).
- Document default build, test, and QA commands for new repos.
- Add CI templates or guidance for automated checks.
- Provide an example project configuration and minimal setup checklist.
Contributing
- Follow the rules in
docs/agentRules/before any commit. - Keep documentation concise and update
docs/README.mdwhen adding new docs. - Do not include code snippets in markdown, except Mermaid diagrams.