codex-workflows 0.2.2 → 0.2.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.agents/skills/documentation-criteria/SKILL.md +3 -3
- package/.agents/skills/documentation-criteria/references/design-template.md +1 -26
- package/.agents/skills/documentation-criteria/references/plan-template.md +3 -18
- package/.agents/skills/recipe-add-integration-tests/SKILL.md +58 -18
- package/.agents/skills/recipe-diagnose/SKILL.md +20 -4
- package/.agents/skills/recipe-reverse-engineer/SKILL.md +13 -5
- package/.codex/agents/code-verifier.toml +53 -20
- package/.codex/agents/investigator.toml +14 -15
- package/.codex/agents/prd-creator.toml +39 -24
- package/.codex/agents/scope-discoverer.toml +23 -27
- package/.codex/agents/task-decomposer.toml +1 -1
- package/.codex/agents/technical-designer-frontend.toml +70 -117
- package/.codex/agents/technical-designer.toml +72 -116
- package/.codex/agents/verifier.toml +5 -12
- package/.codex/agents/work-planner.toml +7 -6
- package/package.json +1 -1
|
@@ -123,28 +123,24 @@ When the design introduces or significantly modifies data structures:
|
|
|
123
123
|
- 3+ criteria fail → New structure justified
|
|
124
124
|
- Record decision and rationale in Design Doc
|
|
125
125
|
|
|
126
|
-
### Integration
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
3. **Reflection in Design Doc**
|
|
145
|
-
- Create "## Integration Point Map" section
|
|
146
|
-
- Clarify responsibilities and boundaries at each integration point
|
|
147
|
-
- Define error behavior at design phase
|
|
126
|
+
### Integration Points【Important】
|
|
127
|
+
Document all integration points with existing systems in a "## Integration Point Map" section.
|
|
128
|
+
|
|
129
|
+
For each integration point, record:
|
|
130
|
+
- Existing component and method
|
|
131
|
+
- Integration method
|
|
132
|
+
- Impact level
|
|
133
|
+
- Required test coverage
|
|
134
|
+
|
|
135
|
+
Impact level criteria:
|
|
136
|
+
- High: modifies or extends an existing process flow
|
|
137
|
+
- Medium: reuses or updates existing data or contracts
|
|
138
|
+
- Low: read-only interaction, observation, or non-invasive integration
|
|
139
|
+
|
|
140
|
+
For each integration boundary, define:
|
|
141
|
+
- Input
|
|
142
|
+
- Output
|
|
143
|
+
- On Error
|
|
148
144
|
|
|
149
145
|
### Agreement Checklist【Most Important】
|
|
150
146
|
Must be performed at the beginning of Design Doc creation:
|
|
@@ -213,32 +209,20 @@ Perform before Design Doc creation:
|
|
|
213
209
|
|
|
214
210
|
Common ADR needed when: Technical decisions common to multiple components
|
|
215
211
|
|
|
216
|
-
### Integration Point Specification
|
|
217
|
-
Document integration points with existing system (location, old implementation, new implementation, switching method).
|
|
218
|
-
|
|
219
212
|
### Data Contracts
|
|
220
213
|
Define input/output between components (types, preconditions, guarantees, error behavior).
|
|
221
214
|
|
|
222
215
|
### State Transitions (When Applicable)
|
|
223
216
|
Document state definitions and transitions for stateful components.
|
|
224
217
|
|
|
225
|
-
|
|
226
|
-
Define input/output, sync/async, and error handling at component boundaries in language-agnostic manner.
|
|
227
|
-
|
|
228
|
-
```yaml
|
|
229
|
-
Boundary Name: [Connection Point]
|
|
230
|
-
Input: [What is received]
|
|
231
|
-
Output: [What is returned (specify sync/async)]
|
|
232
|
-
On Error: [How to handle]
|
|
233
|
-
```
|
|
234
|
-
|
|
235
|
-
Confirm and document conflicts with existing systems (priority, naming conventions, etc.) to prevent integration inconsistencies.
|
|
218
|
+
Confirm and document conflicts with existing systems at each integration point to prevent inconsistencies.
|
|
236
219
|
|
|
237
220
|
## Required Information
|
|
238
221
|
|
|
239
222
|
- **Operation Mode**:
|
|
240
223
|
- `create`: New creation (default)
|
|
241
224
|
- `update`: Update existing document
|
|
225
|
+
- `reverse-engineer`: Document existing architecture as-is
|
|
242
226
|
|
|
243
227
|
- **Requirements Analysis Results**: Requirements analysis results (scale determination, technical requirements, etc.)
|
|
244
228
|
- **PRD**: PRD document (if exists)
|
|
@@ -257,40 +241,15 @@ Confirm and document conflicts with existing systems (priority, naming conventio
|
|
|
257
241
|
- Reason for changes
|
|
258
242
|
- Sections needing updates
|
|
259
243
|
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
244
|
+
- **Reverse-Engineer Context** (reverse-engineer mode only):
|
|
245
|
+
- Primary Files
|
|
246
|
+
- Public Interfaces
|
|
247
|
+
- Dependencies
|
|
248
|
+
- Unit Inventory (routes, test files, public exports)
|
|
263
249
|
|
|
264
|
-
|
|
265
|
-
```markdown
|
|
266
|
-
# ADR-XXXX: [Title]
|
|
267
|
-
Status: Proposed
|
|
268
|
-
|
|
269
|
-
## Background
|
|
270
|
-
[Technical challenges and constraints in 1-2 sentences]
|
|
271
|
-
|
|
272
|
-
## Options
|
|
273
|
-
### Option A: [Approach Name]
|
|
274
|
-
- Overview: [Explain in one sentence]
|
|
275
|
-
- Benefits: [2-3 items]
|
|
276
|
-
- Drawbacks: [2-3 items]
|
|
277
|
-
- Effort: X days
|
|
278
|
-
|
|
279
|
-
### Option B/C: [Document similarly]
|
|
280
|
-
|
|
281
|
-
## Comparison
|
|
282
|
-
| Evaluation Axis | Option A | Option B | Option C |
|
|
283
|
-
|-----------------|----------|----------|----------|
|
|
284
|
-
| Implementation Effort | 3 days | 5 days | 2 days |
|
|
285
|
-
| Maintainability | High | Medium | Low |
|
|
286
|
-
|
|
287
|
-
## Decision
|
|
288
|
-
Option [X] selected. Reason: [2-3 sentences including trade-offs]
|
|
289
|
-
```
|
|
290
|
-
|
|
291
|
-
See ADR template in documentation-criteria skill for details.
|
|
250
|
+
## Document Output Format
|
|
292
251
|
|
|
293
|
-
###
|
|
252
|
+
### Document Creation
|
|
294
253
|
- **ADR**: `docs/adr/ADR-[4-digit number]-[title].md` (e.g., ADR-0001)
|
|
295
254
|
- **Design Doc**: `docs/design/[feature-name]-design.md`
|
|
296
255
|
- Follow respective templates (`template.md`)
|
|
@@ -344,25 +303,33 @@ Implementation sample creation checklist:
|
|
|
344
303
|
- [ ] Comparison matrix completeness
|
|
345
304
|
|
|
346
305
|
### Design Doc Checklist
|
|
306
|
+
**All modes**:
|
|
307
|
+
- [ ] **Standards identification gate completed** (required)
|
|
308
|
+
- [ ] **Code inspection evidence recorded** (required)
|
|
309
|
+
- [ ] **Integration points enumerated with contracts** (required)
|
|
310
|
+
- [ ] **Data contracts clarified** (required)
|
|
311
|
+
- [ ] Architecture and data flow clearly expressed in diagrams
|
|
312
|
+
|
|
313
|
+
**Create/update mode only**:
|
|
347
314
|
- [ ] **Agreement checklist completed** (most important)
|
|
348
315
|
- [ ] **Prerequisite common ADRs referenced** (required)
|
|
349
316
|
- [ ] **Change impact map created** (required)
|
|
350
|
-
- [ ] **Integration boundary contracts defined** (required)
|
|
351
|
-
- [ ] **Integration points completely enumerated** (required)
|
|
352
|
-
- [ ] **Data contracts clarified** (required)
|
|
353
|
-
- [ ] **E2E verification procedures for each phase** (required)
|
|
354
317
|
- [ ] Response to requirements and design validity
|
|
355
|
-
- [ ]
|
|
356
|
-
- [ ]
|
|
318
|
+
- [ ] Error handling strategy
|
|
319
|
+
- [ ] Acceptance criteria written in testable format: each criterion includes a measurable condition and expected outcome (verifiable by acceptance-test-generator)
|
|
357
320
|
- [ ] Interface change matrix completeness
|
|
358
321
|
- [ ] Implementation approach selection rationale (vertical/horizontal/hybrid)
|
|
359
322
|
- [ ] Latest best practices researched and references cited
|
|
360
323
|
- [ ] **Complexity assessment**: complexity_level set; if medium/high, complexity_rationale specifies (1) requirements/ACs, (2) constraints/risks
|
|
361
|
-
- [ ] **Standards identification gate completed** (required)
|
|
362
|
-
- [ ] **Code inspection evidence recorded** (required)
|
|
363
324
|
- [ ] **Data representation decision documented** (when new structures introduced)
|
|
364
325
|
- [ ] **Field propagation map included** (when fields cross boundaries)
|
|
365
326
|
|
|
327
|
+
**Reverse-engineer mode only**:
|
|
328
|
+
- [ ] Every architectural claim cites file:line evidence
|
|
329
|
+
- [ ] Identifiers are transcribed exactly from code
|
|
330
|
+
- [ ] Test existence is confirmed by enumeration
|
|
331
|
+
- [ ] All provided Unit Inventory items are accounted for
|
|
332
|
+
|
|
366
333
|
|
|
367
334
|
## Acceptance Criteria Creation Guidelines
|
|
368
335
|
|
|
@@ -397,53 +364,42 @@ Implementation sample creation checklist:
|
|
|
397
364
|
|
|
398
365
|
*Note: Non-functional requirements (performance, reliability, etc.) are defined in the "Non-functional Requirements" section and automatically verified by quality check tools
|
|
399
366
|
|
|
400
|
-
## Latest Information Research
|
|
401
|
-
|
|
402
|
-
### Research Timing
|
|
403
|
-
1. **Mandatory Research**:
|
|
404
|
-
- When considering new technology/library introduction
|
|
405
|
-
- When designing performance optimization
|
|
406
|
-
- When designing security-related implementation
|
|
407
|
-
- When major version upgrades of existing technology
|
|
408
|
-
|
|
409
|
-
2. **Recommended Research**:
|
|
410
|
-
- Before implementing complex algorithms
|
|
411
|
-
- When considering improvements to existing patterns
|
|
367
|
+
## Latest Information Research
|
|
412
368
|
|
|
413
|
-
|
|
369
|
+
Use current-year queries and cite sources in a `## References` section for create/update mode.
|
|
414
370
|
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
**Specific Search Pattern Examples**:
|
|
418
|
-
To get latest information, always check current year before searching:
|
|
419
|
-
```bash
|
|
420
|
-
date +%Y # e.g., 2025
|
|
421
|
-
```
|
|
422
|
-
Include this year in search queries:
|
|
423
|
-
- `[technology] [feature] best practices {current_year}` (new feature research)
|
|
424
|
-
- `[tech A] vs [tech B] performance comparison {current_year}` (technology selection)
|
|
425
|
-
- `[architecture pattern] [concern] patterns` (design patterns)
|
|
426
|
-
- `[framework] v[X] breaking changes migration guide` (version upgrade)
|
|
427
|
-
- `[framework name] official documentation` (official docs don't need year)
|
|
428
|
-
|
|
429
|
-
**Citation**: Add "## References" section at end of ADR/Design Doc with URLs and descriptions
|
|
430
|
-
|
|
431
|
-
### Citation Format
|
|
432
|
-
|
|
433
|
-
Add at the end of ADR/Design Doc in the following format:
|
|
434
|
-
|
|
435
|
-
```markdown
|
|
436
|
-
## References
|
|
437
|
-
|
|
438
|
-
- [Title](URL) - Brief description of referenced content
|
|
439
|
-
- [Framework Official Documentation](URL) - Related design principles and features
|
|
440
|
-
- [Technical Blog Article](URL) - Implementation patterns and best practices
|
|
441
|
-
```
|
|
371
|
+
Reverse-engineer mode skips latest-information research because it documents what exists.
|
|
442
372
|
|
|
443
373
|
## Update Mode Operation
|
|
444
374
|
- **ADR**: Update existing file for minor changes, create new file for major changes
|
|
445
375
|
- **Design Doc**: Add revision section and record change history
|
|
446
376
|
|
|
377
|
+
## Reverse-Engineer Mode (As-Is Documentation)
|
|
378
|
+
|
|
379
|
+
Use this mode when documenting existing architecture rather than proposing changes.
|
|
380
|
+
|
|
381
|
+
What to skip:
|
|
382
|
+
- ADR creation
|
|
383
|
+
- Option comparison
|
|
384
|
+
- Change Impact Map
|
|
385
|
+
- Field Propagation Map
|
|
386
|
+
- Implementation Approach Decision
|
|
387
|
+
- Latest Information Research
|
|
388
|
+
|
|
389
|
+
Execution steps:
|
|
390
|
+
1. Enumerate entry points from Primary Files and Unit Inventory. Record each public handler, command, or exported interface with file:line evidence
|
|
391
|
+
2. Trace each entry point through directly called services, helpers, and data-access code. Record actual data flow and error handling with file:line evidence
|
|
392
|
+
3. Record contracts exactly as implemented:
|
|
393
|
+
- inputs and parameters
|
|
394
|
+
- outputs and response shapes
|
|
395
|
+
- middleware, guards, and integration boundaries
|
|
396
|
+
4. Read schemas, types, defaults, constants, and enums referenced by the traced flow. Record names and values exactly as written in code
|
|
397
|
+
5. Enumerate tests for the unit and map each test file to the interfaces or flows it covers. Record uncovered Unit Inventory items explicitly
|
|
398
|
+
|
|
399
|
+
Completion rule for reverse-engineer mode:
|
|
400
|
+
- Every Unit Inventory route or public export is accounted for in the Design Doc
|
|
401
|
+
- Every claim about architecture, data flow, public contracts, integrations, or error handling cites file:line evidence
|
|
402
|
+
|
|
447
403
|
## Completion Gate [BLOCKING]
|
|
448
404
|
|
|
449
405
|
☐ All completion criteria met with evidence
|
|
@@ -46,13 +46,6 @@ Skill Status:
|
|
|
46
46
|
This agent outputs **investigation result verification and conclusion derivation only**.
|
|
47
47
|
Solution derivation is out of scope for this agent.
|
|
48
48
|
|
|
49
|
-
## Core Responsibilities
|
|
50
|
-
|
|
51
|
-
1. **Triangulation Supplementation** - Explore information sources not covered in the investigation to supplement results
|
|
52
|
-
2. **ACH (Analysis of Competing Hypotheses)** - Generate alternative hypotheses beyond those listed in the investigation and evaluate consistency with evidence
|
|
53
|
-
3. **Devil's Advocate** - Assume "the investigation results are wrong" and actively seek refutation
|
|
54
|
-
4. **Conclusion Derivation** - Adopt unrefuted hypotheses as causes and determine relationship when multiple
|
|
55
|
-
|
|
56
49
|
## Execution Steps
|
|
57
50
|
|
|
58
51
|
### Step 1: Investigation Results Verification Preparation
|
|
@@ -71,11 +64,11 @@ Solution derivation is out of scope for this agent.
|
|
|
71
64
|
- Verify logical validity of impactAnalysis (without additional searches)
|
|
72
65
|
|
|
73
66
|
### Step 2: Triangulation Supplementation
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
67
|
+
Identify which source types are missing from `investigationSources`, then investigate at least one uncovered source type.
|
|
68
|
+
|
|
69
|
+
If all source types were already covered, investigate a different code area or configuration path than the original investigation.
|
|
70
|
+
|
|
71
|
+
Record each supplementary finding and its impact on the existing hypotheses.
|
|
79
72
|
|
|
80
73
|
### Step 3: External Information Reinforcement (web search)
|
|
81
74
|
- Official information about hypotheses found in investigation
|
|
@@ -40,7 +40,7 @@ Skill Status:
|
|
|
40
40
|
2. Clarify task dependencies
|
|
41
41
|
3. Phase division and prioritization
|
|
42
42
|
4. Define completion criteria for each task (derived from Design Doc acceptance criteria)
|
|
43
|
-
5.
|
|
43
|
+
5. Place test implementation and execution appropriately for each phase
|
|
44
44
|
6. Concretize risks and countermeasures
|
|
45
45
|
7. Document in progress-trackable format
|
|
46
46
|
|
|
@@ -60,7 +60,7 @@ Skill Status:
|
|
|
60
60
|
Read the Design Doc(s), UI Spec, PRD, and ADR (if provided). Extract:
|
|
61
61
|
- Acceptance criteria and implementation approach
|
|
62
62
|
- Technical dependencies and implementation order
|
|
63
|
-
- Integration points
|
|
63
|
+
- Integration points and their contracts
|
|
64
64
|
|
|
65
65
|
### 2. Process Test Design Information (when provided)
|
|
66
66
|
Read test skeleton files and extract meta information (see Test Design Information Processing section).
|
|
@@ -71,7 +71,8 @@ Choose Strategy A (TDD) if test skeletons are provided, Strategy B (implementati
|
|
|
71
71
|
### 4. Compose Phases
|
|
72
72
|
Structure phases based on technical dependencies from Design Doc:
|
|
73
73
|
- Place tasks with lowest dependencies in earlier phases
|
|
74
|
-
-
|
|
74
|
+
- When test skeletons are provided, place integration test implementation based on `@dependency` metadata from test skeletons (see Test Design Information Processing > Step 2) and place E2E test execution in the final phase
|
|
75
|
+
- When test skeletons are not provided, include test implementation tasks based on Design Doc acceptance criteria
|
|
75
76
|
- Include quality assurance in final phase
|
|
76
77
|
|
|
77
78
|
### 5. Define Tasks with Completion Criteria
|
|
@@ -206,8 +207,8 @@ Verification: L1 — [specific verification method]
|
|
|
206
207
|
Compose phases based on technical dependencies and implementation approach from Design Doc.
|
|
207
208
|
Always include quality assurance (all tests passing, acceptance criteria achieved) in final phase.
|
|
208
209
|
|
|
209
|
-
###
|
|
210
|
-
|
|
210
|
+
### Test Skeleton Integration
|
|
211
|
+
Follow the test skeleton placement rules defined in Step 4 of the Planning Process.
|
|
211
212
|
|
|
212
213
|
## Diagram Creation (using mermaid notation)
|
|
213
214
|
|
|
@@ -219,7 +220,7 @@ When creating work plans, **Phase Structure Diagrams** and **Task Dependency Dia
|
|
|
219
220
|
- [ ] Phase composition based on technical dependencies
|
|
220
221
|
- [ ] All requirements converted to tasks
|
|
221
222
|
- [ ] Quality assurance exists in final phase
|
|
222
|
-
- [ ]
|
|
223
|
+
- [ ] Test skeleton file paths listed in corresponding phases (when provided)
|
|
223
224
|
- [ ] Test design information reflected (only when provided)
|
|
224
225
|
- [ ] Setup tasks placed in first phase
|
|
225
226
|
- [ ] Risk level-based prioritization applied
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "codex-workflows",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.4",
|
|
4
4
|
"description": "Task-oriented agentic coding framework for OpenAI Codex CLI — skills, recipes, and subagents for structured development workflows",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Shinsuke Kagawa",
|