Skip to content

RaphaelBatagini/ai-engineering-workflows

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ai-engineering-workflows

Engineering workflows, prompt standards, and operational patterns for AI-assisted software delivery.


This repository is a practical reference for engineering teams integrating AI tools into real engineering processes — code review, incident investigation, architecture decisions, async communication, and delivery operations.

It is not a prompt collection. It is not an AI capabilities showcase. It is an engineering playbook.


What this is

  • A structured library of AI-assisted engineering workflows with explicit human review gates
  • Prompt engineering standards for consistent, reviewable AI inputs
  • Quality criteria and validation checklists for AI-generated outputs
  • Operational examples using Claude Code, MCP-enabled toolchains, and GitHub/Jira/DataDog integrations
  • A reference architecture for teams that want to adopt AI systematically, not opportunistically

Core Design Principles

  • AI outputs must be reviewable
  • Workflows should reduce cognitive overhead
  • Engineering judgment remains human-owned
  • Prompts are operational specifications
  • Validation gates are mandatory
  • Consistency is more valuable than novelty

Engineering Principles

1. AI assists; engineers decide. Every workflow in this repository includes explicit human review gates. AI output is always an input to an engineering decision — never the decision itself.

2. Structured inputs produce reviewable outputs. Prompt quality is an engineering concern. Vague prompts produce vague outputs. This repository treats prompts as specifications with input contracts, output contracts, and failure modes.

3. Validation is not optional. AI-generated outputs — code, analysis, documentation — require the same review discipline as any other engineering artifact. Quality gates are defined per workflow, not left to individual discretion.

4. Workflows before tooling. The process design matters more than the specific model or tool. Workflows in this repository are tool-informed but not tool-dependent. When tools change, workflows adapt.

5. Operational reliability over feature coverage. A small set of well-designed, consistently applied workflows delivers more value than a large library of inconsistently used ones.


Repository Map

Directory Purpose
workflows/ Process specifications for AI-assisted engineering tasks
prompts/ Prompt specifications: input contracts, output contracts, failure modes
guardrails/ Review checklists, quality gates, validation criteria
docs/standards/ Authoring standards for workflows and prompts
examples/ Representative artifacts from real operational patterns
templates/ Reusable scaffolding for new workflows, prompts, and ADRs
docs/onboarding/ Getting started guide for new contributors and users

Workflow Index

Engineering

Workflow Use case
PR Review AI-assisted pull request analysis with structured review output
Code Review Systematic code quality review using AI-generated analysis
Debugging Structured debugging sessions with AI hypothesis generation
Architecture Review AI-assisted architecture analysis and decision support
Incident Investigation AI-accelerated root cause analysis with engineer-led conclusions
Technical Decision Structured decision support with tradeoff analysis

Delivery

Workflow Use case
Ticket Refinement AI-assisted acceptance criteria, scope analysis, and edge case identification
Documentation Engineering documentation generation with review workflow
Onboarding AI-accelerated onboarding material generation and knowledge transfer

Communication

Workflow Use case
Async Communication AI-assisted async update drafting, standup summaries, and status reports

Operations

Workflow Use case
DataDog Investigation AI-assisted observability analysis and alert investigation
Postmortem Structured postmortem documentation with AI-assisted timeline reconstruction

Getting Started

Using a workflow:

  1. Navigate to the relevant workflow file in workflows/
  2. Review the prerequisites and input requirements
  3. Follow the steps — each step identifies the AI role, the human role, and the validation gate
  4. Apply the quality checklist before accepting any output

Using a prompt:

  1. Navigate to the corresponding prompt in prompts/
  2. Satisfy the input contract before running the prompt
  3. Evaluate the output against the validation criteria defined in the prompt file
  4. Consult the failure modes section if output quality is low

Adding a new workflow: See CONTRIBUTING.md and the workflow template.


Standards


Philosophy

The full engineering philosophy behind this repository is in PHILOSOPHY.md.


Contributing

See CONTRIBUTING.md for workflow and prompt authoring standards, naming conventions, and the review process for new contributions.

About

Engineering workflows, prompt standards, and operational patterns for AI-assisted software delivery.

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors