diff --git a/README.md b/README.md index 66e4936..6ddfd5e 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,9 @@

codex-sdlc

- Coordinate AI teams. Deliver software with evidence.
- Turn a feature request into a resumable delivery workflow across one repository or many.
- Choose models by role. Verify the work. Keep the final decision yours. + One request. A complete delivery workflow.
+ Describe what you want to build. codex-sdlc coordinates the work from requirements to final review.
+ You steer the decisions. The AI team carries the process forward.

@@ -29,24 +29,31 @@ --- -## A delivery process you can pick up again +## Describe the outcome. Start the workflow. -codex-sdlc combines **seven Codex skills** with a **repository-local CLI**. It coordinates requirements, implementation, integration, independent quality control, and optional AI Product Owner review. Tasks, evidence, and decisions stay in your repository so the next session can continue from recorded state. +Once your project is set up, give Codex a feature request in plain language. **codex-sdlc leads the delivery process** through requirements, planning, implementation, integration, independent quality control, and a final delivery report. It brings you in for clarifications and material decisions; final acceptance remains yours. + +

+ Amber YOU stages: describe your request, clarify goals and approve material decisions when needed, then accept the delivery or request changes. Teal AI stages: requirements and planning, implementation and integration, independent QC, and a delivery report with optional AI Product Owner advice. The coordinator records the workflow so it can resume later. +

+ +**Amber / YOU:** provide the request and make decisions. **Teal / AI:** coordinate and carry out the delivery work. + +PM coordinates the stages and reviews each handoff. Frontend work follows the reviewed API contract; independent QC follows integration. The optional AI Product Owner offers advice before PM prepares the final package. **Only you accept delivery.** + +### A workflow you can resume + +Seven Codex skills and a repository-local CLI keep tasks, evidence, blockers, and decisions in your repository. The next session can continue from recorded state. | What you need | What codex-sdlc provides | | --- | --- | +| Turn a simple request into a delivery workflow | Coordinated requirements, implementation, independent QC, and a final report. | | Continue work across sessions | Saved run manifests, task dependencies, blockers, and decisions. | | Work across separate codebases | One coordinator with explicit backend, web, and mobile repository mappings. | | Choose a model for each role | Per-role model and reasoning settings, explicit fallbacks, and dispatch records. | | Know what was actually verified | Independent QC, acceptance coverage, and recorded command evidence. | | Stay in control of delivery | Optional AI Product Owner advice followed by your explicit acceptance. | -

- Delivery overview: PM and BA define requirements; backend and frontend implement reviewed contracts; independent QC verifies evidence; optional AI Product Owner review informs the human decision. A coordinator repository stores the delivery record. -

- -PM coordinates the stages and reviews each handoff. Frontend work follows the reviewed API contract; independent QC follows integration. The optional AI Product Owner recommends readiness for your review. **Only you accept delivery.** - ## Get started You need **Codex**, **Node.js `>=24.16.0 <25`**, **npm 11**, and an existing application repository. Setup configures your application directories; it does not scaffold application code. diff --git a/assets/brand/delivery-overview.svg b/assets/brand/delivery-overview.svg index d100e44..d4466ea 100644 --- a/assets/brand/delivery-overview.svg +++ b/assets/brand/delivery-overview.svg @@ -1,61 +1,85 @@ - - From feature request to human acceptance - Four delivery stages: define requirements with PM and BA, build through backend and frontend roles, verify with independent QC, and decide with optional AI Product Owner advice and final human acceptance. A coordinator repository stores requirements, tasks, evidence, and decisions. + + One request. A complete delivery workflow. + Amber cards labeled YOU show the user's feature request and final acceptance. Four teal cards labeled AI show requirements and planning, implementation and integration, independent quality checks, and the delivery report with optional AI Product Owner advice. The user also clarifies goals and approves material decisions when needed. The coordinator's .sdlc folder stores the resumable delivery record. - + - THE DELIVERY LOOP - One request. A traceable delivery. - One repository or many. Clear roles at every stage. + FROM REQUEST TO FINAL REVIEW + One request. A complete delivery workflow. + AI coordinates the process. You steer the decisions. - - + + YOU · input and decisions + + AI · coordinated delivery work + + + + + + + - - - - - + + + + + - - 01 / DEFINE - 02 / BUILD - 03 / VERIFY - 04 / DECIDE + + YOU + YOU - - Define the outcome - Build within scope - Verify the result - Make the decision + + AI + AI + AI + AI - - PM + business analysis - Requirements and criteria - Backend + frontend - Reviewed API contracts - Independent QC - Coverage, defects, retests - AI PO advice is optional - Human acceptance is final + + Your + request + Requirements + and plan + Build and + integrate + Independent + quality checks + Delivery + report + Your + acceptance - - PM reviews the handoff - PM integrates the work - Results recorded in the run - PM prepares the final package + + Describe the outcome + in plain language + PM + business analysis + Acceptance criteria + Backend + frontend + PM integration + Independent QC + Coverage + retests + AI PO (optional) + PM report + evidence + Accept or request + changes - - - .sdlc/ - Your coordinator keeps the record. - Requirements · tasks · evidence · decisions + + + YOU STAY IN THE LOOP + Clarify goals and approve material decisions when needed. + + + + .sdlc/ + Your coordinator keeps the record. + Requirements · tasks · evidence · decisions