codex-workflows 0.4.5 → 0.4.6

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.
Files changed (4) hide show
  1. package/.agents/skills/documentation-criteria/SKILL.md +1 -1
  2. package/.agents/skills/documentation-criteria/references/prd-template.md +6 -3
  3. package/.agents/skills/documentation-criteria/references/ui-spec-template.md +50 -9
  4. package/package.json +1 -1
package/.agents/skills/documentation-criteria/SKILL.md CHANGED
@@ -53,7 +53,7 @@ description: "Documentation creation criteria for PRD, ADR, Design Doc, UI Spec,
53
53
 
54
54
  ### PRD (Product Requirements Document)
55
55
  **Purpose**: Define business requirements and user value
56
- **Scope**: Business requirements, user value, success metrics, user stories, MoSCoW prioritization, MVP/Future phase separation, user journey diagram, and scope boundary diagram only. Technical implementation details belong in Design Doc, technical decision rationale in ADR, and implementation phases or task breakdown belong in Work Plan.
56
+ **Scope**: Business requirements, user value, success metrics, user stories, MoSCoW prioritization, MVP/Future phase separation, user journey diagram, scope boundary diagram, and acceptance criteria with sequential IDs (for example `AC-001`, `AC-002`, continuing across all requirements in the document) only. Technical implementation details belong in Design Doc, technical decision rationale in ADR, and implementation phases or task breakdown belong in Work Plan.
57
57
 
58
58
  ### ADR (Architecture Decision Record)
59
59
  **Purpose**: Record technical decision rationale and background
package/.agents/skills/documentation-criteria/references/prd-template.md CHANGED
@@ -29,15 +29,18 @@ So that [expected value/benefit]
29
29
 
30
30
  ### Must Have (MVP)
31
31
  - [ ] Requirement 1: [Detailed description]
32
- - AC: [Acceptance criteria - Given/When/Then format or measurable standard]
32
+ - AC-001: [Acceptance criteria - Given/When/Then format or measurable standard]
33
+ - AC-002: [Acceptance criteria]
33
34
  - [ ] Requirement 2: [Detailed description]
34
- - AC: [Acceptance criteria]
35
+ - AC-003: [Acceptance criteria]
35
36
  - [ ] Requirement 3: [Detailed description]
36
- - AC: [Acceptance criteria]
37
+ - AC-004: [Acceptance criteria]
37
38
 
38
39
  ### Nice to Have
39
40
  - [ ] Requirement 1: [Detailed description]
41
+ - AC-005: [Acceptance criteria - continue numbering across all requirements]
40
42
  - [ ] Requirement 2: [Detailed description]
43
+ - AC-006: [Acceptance criteria]
41
44
 
42
45
  ### Out of Scope
43
46
  - Item 1: [Description and reason]
package/.agents/skills/documentation-criteria/references/ui-spec-template.md CHANGED
@@ -28,7 +28,7 @@ Map PRD acceptance criteria to prototype references. Skip this section if no pro
28
28
 
29
29
  | AC ID | AC Summary | Screen / State | Prototype Reference (element ID / path) | Adoption Decision |
30
30
  |-------|-----------|----------------|----------------------------------------|-------------------|
31
- | AC-01 | [EARS AC summary] | [Screen / state name] | [element or file reference] | Adopted / Not adopted / On hold |
31
+ | AC-001 | [EARS AC summary] | [Screen / state name] | [element or file reference] | Adopted / Not adopted / On hold |
32
32
 
33
33
  ## Screen List and Transitions
34
34
 
@@ -61,15 +61,19 @@ Map PRD acceptance criteria to prototype references. Skip this section if no pro
61
61
 
62
62
  #### State x Display Matrix
63
63
 
64
- | State | Default | Loading | Empty | Error | Partial |
65
- |-------|---------|---------|-------|-------|---------|
66
- | Display | [Normal display] | [Skeleton / spinner] | [Empty state + CTA] | [Error message + recovery action] | [Cached / partial display] |
64
+ List only states that actually exist for this component. Remove unused rows. Include fallback or degraded states only when explicitly required by the PRD or existing behavior.
65
+
66
+ | State | Trigger / Condition | Display | Recovery / Notes |
67
+ |-------|---------------------|---------|------------------|
68
+ | Default | [Initial or ready condition] | [Normal display] | [Notes if needed] |
69
+ | Loading | [Data or action in progress] | [e.g., skeleton matching final layout] | [Cancellation, timeout, or transition notes if relevant] |
70
+ | Error | [Failure condition] | [e.g., inline `Alert` + "Retry"] | [Recovery action required by product behavior] |
67
71
 
68
72
  #### Interaction Definition
69
73
 
70
74
  | AC ID | EARS Condition | User Action | System Response | State Transition | Error Handling |
71
75
  |-------|---------------|-------------|-----------------|-----------------|----------------|
72
- | AC-01 | When [trigger] | [Click / input / etc.] | [Expected behavior] | [From state -> To state] | [Retry / Reset / Fallback] |
76
+ | AC-001 | When [trigger] | [Click / input / etc.] | [Expected behavior] | [From state -> To state] | [Retry / Reset / Explicitly defined degraded behavior if any] |
73
77
 
74
78
  ### Component: [ComponentName2]
75
79
 
@@ -79,9 +83,16 @@ Map PRD acceptance criteria to prototype references. Skip this section if no pro
79
83
 
80
84
  ### Environment Constraints
81
85
  - Target browsers: [e.g., Chrome 120+, Safari 17+]
82
- - Responsive breakpoints: [e.g., 768px, 1024px, 1280px]
83
86
  - Theme support: [e.g., light/dark, system preference]
84
87
 
88
+ #### Responsive Behavior
89
+
90
+ | Breakpoint | Width | Key Changes |
91
+ |-----------|-------|-------------|
92
+ | Mobile | [e.g., < 768px] | [e.g., single-column layout, compact navigation, reduced non-critical detail] |
93
+ | Tablet | [e.g., 768px - 1023px] | [e.g., two-column layout, condensed sidebar, larger touch targets] |
94
+ | Desktop | [e.g., >= 1024px] | [e.g., full layout, persistent navigation, expanded comparison views] |
95
+
85
96
  ### Existing Component Reuse Map
86
97
 
87
98
  | UI Element | Decision | Existing Component | Notes |
@@ -90,12 +101,42 @@ Map PRD acceptance criteria to prototype references. Skip this section if no pro
90
101
  | [DataTable] | Extend | [components/ui/Table] | [Add sorting support] |
91
102
  | [FeatureCard] | New | - | [No similar component exists] |
92
103
 
93
- ### Design Tokens
104
+ ### Design Tokens (include only when existing tokens must be referenced or a new visual system must be defined)
105
+
106
+ Prefer existing design-system tokens, theme variables, or component-library primitives. If the project does not define tokens at this level, replace this section with a short note such as `N/A - existing component library styles are used without new token definitions`. If the entire Design Tokens section is `N/A`, skip all subsections below.
107
+
108
+ #### Color Roles
109
+
110
+ Remove unused subsections and rows. Do not invent token names or values that are not supported by the codebase, design system, or approved design direction.
111
+
112
+ | Role | Token | Value | Usage |
113
+ |------|-------|-------|-------|
114
+ | Background Surface | [existing token] | [actual value if defined] | [Page or container background] |
115
+ | Brand / Accent | [existing token] | [actual value if defined] | [Primary actions and emphasis] |
116
+
117
+ #### Typography Hierarchy
118
+
119
+ | Role | Font | Size | Weight | Line Height | Letter Spacing |
120
+ |------|------|------|--------|-------------|----------------|
121
+ | Body | [existing token or family] | [actual size if defined] | [actual weight if defined] | [actual line height if defined] | [actual letter spacing if defined] |
122
+
123
+ #### Spacing Scale
124
+
125
+ | Token | Value | Usage |
126
+ |-------|-------|-------|
127
+ | [existing token] | [actual value if defined] | [Relevant spacing usage] |
128
+
129
+ #### Elevation
130
+
131
+ | Level | Treatment | Usage |
132
+ |-------|-----------|-------|
133
+ | [Relevant level] | [actual token or shadow treatment if defined] | [Where it is used] |
134
+
135
+ #### Border Radius Scale
94
136
 
95
137
  | Token | Value | Usage |
96
138
  |-------|-------|-------|
97
- | [color-primary] | [value] | [Primary actions] |
98
- | [spacing-md] | [value] | [Component spacing] |
139
+ | [existing token] | [actual value if defined] | [Relevant usage] |
99
140
 
100
141
  ## Visual Acceptance
101
142
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "codex-workflows",
3
- "version": "0.4.5",
3
+ "version": "0.4.6",
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",