owflow 0.6.0 → 0.7.0

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 (195) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +448 -283
  3. package/dist/agents/bottleneck-analyzer.md +332 -333
  4. package/dist/agents/code-quality-pragmatist.md +353 -354
  5. package/dist/agents/code-reviewer.md +238 -239
  6. package/dist/agents/codebase-analysis-reporter.md +245 -246
  7. package/dist/agents/docs-operator.md +22 -23
  8. package/dist/agents/e2e-test-verifier.md +447 -448
  9. package/dist/agents/gap-analyzer.md +501 -502
  10. package/dist/agents/implementation-completeness-checker.md +219 -220
  11. package/dist/agents/implementation-planner.md +308 -309
  12. package/dist/agents/information-gatherer.md +690 -691
  13. package/dist/agents/production-readiness-checker.md +278 -279
  14. package/dist/agents/project-analyzer.md +403 -403
  15. package/dist/agents/reality-assessor.md +365 -366
  16. package/dist/agents/research-planner.md +449 -450
  17. package/dist/agents/research-synthesizer.md +402 -403
  18. package/dist/agents/solution-brainstormer.md +256 -257
  19. package/dist/agents/solution-designer.md +371 -372
  20. package/dist/agents/spec-auditor.md +297 -298
  21. package/dist/agents/specification-creator.md +333 -334
  22. package/dist/agents/task-classifier.md +449 -450
  23. package/dist/agents/task-group-implementer.md +283 -284
  24. package/dist/agents/test-suite-runner.md +194 -195
  25. package/dist/agents/user-docs-generator.md +508 -509
  26. package/dist/commands/reviews-code.md +90 -90
  27. package/dist/commands/reviews-pragmatic.md +99 -99
  28. package/dist/commands/reviews-production-readiness.md +113 -113
  29. package/dist/commands/reviews-reality-check.md +110 -110
  30. package/dist/commands/reviews-spec-audit.md +114 -114
  31. package/dist/commands/work.md +280 -280
  32. package/dist/configuration/agents-config.d.ts +2 -0
  33. package/dist/configuration/agents-config.js +8 -44
  34. package/dist/configuration/commands-config.d.ts +23 -0
  35. package/dist/configuration/commands-config.js +17 -17
  36. package/dist/configuration/skills-config.d.ts +2 -0
  37. package/dist/configuration/skills-config.js +3 -3
  38. package/dist/hooks/hooks-diagnostics.d.ts +3 -0
  39. package/dist/hooks/hooks-diagnostics.js +21 -0
  40. package/dist/hooks/hooks-persistence.d.ts +17 -0
  41. package/dist/hooks/hooks-persistence.js +207 -0
  42. package/dist/hooks/hooks-registry.d.ts +6 -0
  43. package/dist/hooks/hooks-registry.js +104 -0
  44. package/dist/hooks/hooks-wrapper.d.ts +25 -0
  45. package/dist/hooks/hooks-wrapper.js +318 -0
  46. package/dist/hooks/internal/before-tool.d.ts +6 -0
  47. package/dist/hooks/internal/before-tool.js +13 -0
  48. package/dist/hooks/internal/session-compaction.d.ts +9 -0
  49. package/dist/hooks/{session-compaction.js → internal/session-compaction.js} +9 -7
  50. package/dist/hooks/runtime/circuit-breaker.d.ts +23 -0
  51. package/dist/hooks/runtime/circuit-breaker.js +39 -0
  52. package/dist/hooks/runtime/failure-policy.d.ts +15 -0
  53. package/dist/hooks/runtime/failure-policy.js +49 -0
  54. package/dist/hooks/runtime/process-executor.d.ts +33 -0
  55. package/dist/hooks/runtime/process-executor.js +147 -0
  56. package/dist/hooks/runtime/status-recorder.d.ts +27 -0
  57. package/dist/hooks/runtime/status-recorder.js +111 -0
  58. package/dist/index.d.ts +7 -0
  59. package/dist/index.js +111 -40
  60. package/dist/skills/agents-md-generator/SKILL.md +223 -223
  61. package/dist/skills/codebase-analyzer/SKILL.md +162 -162
  62. package/dist/skills/codebase-analyzer/references/code-analysis.md +63 -63
  63. package/dist/skills/codebase-analyzer/references/combined.md +31 -31
  64. package/dist/skills/codebase-analyzer/references/context-discovery.md +63 -63
  65. package/dist/skills/codebase-analyzer/references/file-discovery.md +51 -51
  66. package/dist/skills/codebase-analyzer/references/migration-target.md +23 -23
  67. package/dist/skills/codebase-analyzer/references/pattern-mining.md +22 -22
  68. package/dist/skills/dev-analyze/SKILL.md +115 -115
  69. package/dist/skills/dev-bugfix/SKILL.md +452 -452
  70. package/dist/skills/dev-finalize/SKILL.md +118 -118
  71. package/dist/skills/dev-implement/SKILL.md +167 -167
  72. package/dist/skills/dev-plan/SKILL.md +147 -147
  73. package/dist/skills/dev-spec/SKILL.md +182 -182
  74. package/dist/skills/dev-tdd-red/SKILL.md +94 -94
  75. package/dist/skills/dev-verify/SKILL.md +153 -153
  76. package/dist/skills/development/SKILL.md +260 -260
  77. package/dist/skills/diagrams-mermaid/SKILL.md +183 -159
  78. package/dist/skills/diagrams-mermaid/references/reference.md +220 -148
  79. package/dist/skills/docs-manager/SKILL.md +379 -379
  80. package/dist/skills/docs-manager/docs/INDEX.md +199 -199
  81. package/dist/skills/docs-manager/docs/standards/backend/api.md +25 -25
  82. package/dist/skills/docs-manager/docs/standards/backend/migrations.md +22 -22
  83. package/dist/skills/docs-manager/docs/standards/backend/models.md +25 -25
  84. package/dist/skills/docs-manager/docs/standards/backend/queries.md +22 -22
  85. package/dist/skills/docs-manager/docs/standards/frontend/accessibility.md +25 -25
  86. package/dist/skills/docs-manager/docs/standards/frontend/components.md +28 -28
  87. package/dist/skills/docs-manager/docs/standards/frontend/css.md +16 -16
  88. package/dist/skills/docs-manager/docs/standards/frontend/responsive.md +28 -28
  89. package/dist/skills/docs-manager/docs/standards/global/coding-style.md +25 -25
  90. package/dist/skills/docs-manager/docs/standards/global/commenting.md +10 -10
  91. package/dist/skills/docs-manager/docs/standards/global/conventions.md +31 -31
  92. package/dist/skills/docs-manager/docs/standards/global/error-handling.md +22 -22
  93. package/dist/skills/docs-manager/docs/standards/global/minimal-implementation.md +22 -22
  94. package/dist/skills/docs-manager/docs/standards/global/validation.md +28 -28
  95. package/dist/skills/docs-manager/docs/standards/testing/test-writing.md +25 -25
  96. package/dist/skills/docs-manager/references/agents-md-template.md +29 -29
  97. package/dist/skills/docs-manager/references/index-md-template.md +73 -73
  98. package/dist/skills/flow-init/SKILL.md +234 -234
  99. package/dist/skills/flow-init/references/architecture-template.md +45 -45
  100. package/dist/skills/flow-init/references/roadmap-templates.md +93 -93
  101. package/dist/skills/flow-init/references/tech-stack-template.md +70 -70
  102. package/dist/skills/flow-init/references/vision-templates.md +75 -75
  103. package/dist/skills/goal-development/SKILL.md +96 -96
  104. package/dist/skills/goal-migration/SKILL.md +114 -114
  105. package/dist/skills/goal-performance/SKILL.md +126 -126
  106. package/dist/skills/goal-research/SKILL.md +118 -118
  107. package/dist/skills/html-renderer/SKILL.md +173 -173
  108. package/dist/skills/html-renderer/references/index.html +318 -318
  109. package/dist/skills/html-renderer/references/styles.css +388 -388
  110. package/dist/skills/html-renderer/references/tokens.json +104 -104
  111. package/dist/skills/implementation-plan-executor/SKILL.md +378 -378
  112. package/dist/skills/implementation-verifier/SKILL.md +307 -307
  113. package/dist/skills/migration/SKILL.md +268 -268
  114. package/dist/skills/migration-analyze/SKILL.md +126 -126
  115. package/dist/skills/migration-finalize/SKILL.md +161 -161
  116. package/dist/skills/migration-fix/SKILL.md +155 -155
  117. package/dist/skills/migration-implement/SKILL.md +131 -131
  118. package/dist/skills/migration-plan/SKILL.md +131 -131
  119. package/dist/skills/migration-spec/SKILL.md +135 -135
  120. package/dist/skills/migration-spec/references/migration-strategies.md +430 -430
  121. package/dist/skills/migration-target/SKILL.md +134 -134
  122. package/dist/skills/migration-target/references/migration-types.md +489 -489
  123. package/dist/skills/migration-verify/SKILL.md +184 -184
  124. package/dist/skills/orchestrator-framework/SKILL.md +65 -65
  125. package/dist/skills/orchestrator-framework/references/command-namespacing.md +7 -7
  126. package/dist/skills/orchestrator-framework/references/confirm-or-revise-exception.md +20 -20
  127. package/dist/skills/orchestrator-framework/references/delegation-rules.md +54 -54
  128. package/dist/skills/orchestrator-framework/references/dispatcher-handoff.md +27 -27
  129. package/dist/skills/orchestrator-framework/references/fix-loop-contract.md +65 -65
  130. package/dist/skills/orchestrator-framework/references/gate-contract.md +122 -122
  131. package/dist/skills/orchestrator-framework/references/orchestrator-creation-checklist.md +51 -51
  132. package/dist/skills/orchestrator-framework/references/orchestrator-patterns.md +235 -235
  133. package/dist/skills/performance/SKILL.md +267 -267
  134. package/dist/skills/performance-analyze/SKILL.md +129 -129
  135. package/dist/skills/performance-analyze/references/performance-optimization-guide.md +271 -271
  136. package/dist/skills/performance-finalize/SKILL.md +117 -117
  137. package/dist/skills/performance-implement/SKILL.md +114 -114
  138. package/dist/skills/performance-plan/SKILL.md +112 -112
  139. package/dist/skills/performance-spec/SKILL.md +145 -145
  140. package/dist/skills/performance-verify/SKILL.md +164 -164
  141. package/dist/skills/research/SKILL.md +249 -249
  142. package/dist/skills/research-brainstorm/SKILL.md +120 -120
  143. package/dist/skills/research-brainstorm/references/brainstorming-techniques.md +84 -84
  144. package/dist/skills/research-converge/SKILL.md +130 -130
  145. package/dist/skills/research-design/SKILL.md +146 -146
  146. package/dist/skills/research-design/references/design-techniques.md +40 -40
  147. package/dist/skills/research-finalize/SKILL.md +125 -125
  148. package/dist/skills/research-fork/SKILL.md +190 -190
  149. package/dist/skills/research-gather/SKILL.md +133 -133
  150. package/dist/skills/research-plan/SKILL.md +141 -141
  151. package/dist/skills/research-plan/references/research-methodologies.md +710 -710
  152. package/dist/skills/research-quick/SKILL.md +139 -139
  153. package/dist/skills/research-synthesize/SKILL.md +127 -127
  154. package/dist/skills/rule-reviewer/SKILL.md +334 -334
  155. package/dist/skills/standards-discover/SKILL.md +260 -260
  156. package/dist/skills/standards-discover/references/aggregation-strategy.md +76 -76
  157. package/dist/skills/standards-discover/references/code-pattern-prompt.md +68 -68
  158. package/dist/skills/standards-discover/references/config-analyzer-prompt.md +67 -67
  159. package/dist/skills/standards-discover/references/docs-extractor-prompt.md +65 -65
  160. package/dist/skills/standards-discover/references/external-analyzer-prompt.md +75 -75
  161. package/dist/skills/standards-update/SKILL.md +207 -207
  162. package/dist/templates/orchestrator-state-base.yml +17 -17
  163. package/dist/templates/orchestrator-state-development.yml +95 -95
  164. package/dist/templates/orchestrator-state-migration.yml +95 -95
  165. package/dist/templates/orchestrator-state-performance.yml +64 -64
  166. package/dist/templates/orchestrator-state-research.yml +67 -67
  167. package/dist/tools/fork_task.d.ts +17 -0
  168. package/dist/tools/fork_task.js +21 -11
  169. package/dist/tools/verify_template.d.ts +11 -0
  170. package/dist/tools/verify_template.js +32 -17
  171. package/dist/tui/hooks-dialogs.d.ts +20 -0
  172. package/dist/tui/hooks-dialogs.js +181 -0
  173. package/dist/tui/hooks-presenter.d.ts +15 -0
  174. package/dist/tui/hooks-presenter.js +70 -0
  175. package/dist/tui/hooks-sidebar.d.ts +10 -0
  176. package/dist/tui/hooks-sidebar.js +104 -0
  177. package/dist/tui/primitives.d.ts +21 -0
  178. package/dist/tui/primitives.js +47 -0
  179. package/dist/tui.d.ts +12 -0
  180. package/dist/tui.js +129 -0
  181. package/dist/types/hook-types.d.ts +125 -0
  182. package/dist/types/hook-types.js +76 -0
  183. package/dist/types/opencode-types.d.ts +13 -0
  184. package/dist/utils/file-util.d.ts +2 -0
  185. package/dist/utils/file-util.js +6 -6
  186. package/dist/utils/fork-task.d.ts +27 -0
  187. package/dist/utils/fork-task.js +18 -23
  188. package/dist/utils/plugin-info.d.ts +3 -0
  189. package/dist/utils/plugin-info.js +8 -10
  190. package/dist/utils/workflow-paths.d.ts +17 -0
  191. package/dist/utils/workflow-paths.js +18 -0
  192. package/dist/utils/yaml-structure.d.ts +7 -0
  193. package/dist/utils/yaml-structure.js +7 -11
  194. package/package.json +68 -48
  195. package/dist/hooks/before-tool.js +0 -19
@@ -1,199 +1,199 @@
1
- # Documentation Index
2
-
3
- **IMPORTANT**: Read this file at the beginning of any development task to understand available documentation and standards.
4
-
5
- ## Quick Reference
6
-
7
- ### Project Documentation
8
-
9
- Project-level documentation covering vision, goals, architecture, and technology choices.
10
-
11
- ### Technical Standards
12
-
13
- Coding standards, conventions, and best practices organized by domain.
14
-
15
- ---
16
-
17
- ## Project Documentation
18
-
19
- Located in `.owflow/docs/project/`
20
-
21
- ### Vision (`project/vision.md`)
22
-
23
- Defines the project's mission, goals, target users, and long-term vision. Read this to understand the "why" behind the project and align development decisions with project objectives.
24
-
25
- ### Roadmap (`project/roadmap.md`)
26
-
27
- Outlines development milestones, planned features, and timeline. Read this to understand project priorities and upcoming work.
28
-
29
- ### Tech Stack (`project/tech-stack.md`)
30
-
31
- Documents all technologies, frameworks, libraries, and tools used in the project, with rationale for each choice. Read this before adding new dependencies or making technology decisions.
32
-
33
- ### Architecture (`project/architecture.md`)
34
-
35
- Describes the system architecture, component structure, data flow, and design patterns. Read this to understand how the system is organized and how components interact.
36
-
37
- ---
38
-
39
- ## Technical Standards
40
-
41
- ### Global Standards
42
-
43
- Located in `.owflow/docs/standards/global/`
44
-
45
- These standards apply across the entire codebase, regardless of frontend/backend context.
46
-
47
- #### Error Handling (`standards/global/error-handling.md`)
48
-
49
- Structured error types, error propagation patterns, user-facing vs internal error messages, try-catch placement guidelines, error logging conventions.
50
-
51
- #### Validation (`standards/global/validation.md`)
52
-
53
- Input validation at system boundaries, sanitization patterns, validation error message formatting, schema validation approach.
54
-
55
- #### Conventions (`standards/global/conventions.md`)
56
-
57
- Naming conventions (files, variables, functions, classes), file organization patterns, import ordering, code structure guidelines.
58
-
59
- #### Coding Style (`standards/global/coding-style.md`)
60
-
61
- Indentation and formatting rules, spacing conventions, line length limits, bracket style, consistent code readability patterns.
62
-
63
- #### Commenting (`standards/global/commenting.md`)
64
-
65
- When to comment (non-obvious logic only), documentation comment format, inline explanation guidelines, TODO/FIXME conventions.
66
-
67
- #### Minimal Implementation (`standards/global/minimal-implementation.md`)
68
-
69
- No speculative code, no unused methods, no "just in case" abstractions, YAGNI principle enforcement, lean code guidelines.
70
-
71
- ---
72
-
73
- ### Frontend Standards
74
-
75
- Located in `.owflow/docs/standards/frontend/`
76
-
77
- These standards apply to frontend code (UI components, client-side logic, styling).
78
-
79
- #### CSS (`standards/frontend/css.md`)
80
-
81
- CSS naming conventions, stylesheet organization, utility-first vs component styles, CSS variable usage, responsive styling patterns.
82
-
83
- #### Components (`standards/frontend/components.md`)
84
-
85
- Component structure and composition patterns, props design, lifecycle management, smart vs presentational separation.
86
-
87
- #### Accessibility (`standards/frontend/accessibility.md`)
88
-
89
- Keyboard navigation requirements, screen reader support, ARIA attribute usage, WCAG compliance level, focus management patterns.
90
-
91
- #### Responsive Design (`standards/frontend/responsive.md`)
92
-
93
- Breakpoint definitions, mobile-first approach, responsive layout patterns, touch target sizing, viewport considerations.
94
-
95
- ---
96
-
97
- ### Backend Standards
98
-
99
- Located in `.owflow/docs/standards/backend/`
100
-
101
- These standards apply to backend code (APIs, services, data layer).
102
-
103
- #### API Design (`standards/backend/api.md`)
104
-
105
- REST endpoint naming, request/response format conventions, versioning strategy, error response structure, pagination patterns.
106
-
107
- #### Models (`standards/backend/models.md`)
108
-
109
- Data model structure, schema conventions, business logic placement, relationship patterns, model validation rules.
110
-
111
- #### Queries (`standards/backend/queries.md`)
112
-
113
- Query optimization patterns, N+1 prevention, index usage guidelines, query builder conventions, raw query policies.
114
-
115
- #### Migrations (`standards/backend/migrations.md`)
116
-
117
- Migration naming conventions, schema change patterns, data migration approach, rollback requirements, migration testing.
118
-
119
- ---
120
-
121
- ### Testing Standards
122
-
123
- Located in `.owflow/docs/standards/testing/`
124
-
125
- These standards apply to all testing code (unit, integration, E2E).
126
-
127
- #### Test Writing (`standards/testing/test-writing.md`)
128
-
129
- Test naming conventions, test file organization, arrange-act-assert structure, mocking guidelines, coverage expectations, test data management.
130
-
131
- ---
132
-
133
- ## How to Use This Documentation
134
-
135
- 1. **Start Here**: Always read this INDEX.md first to understand what documentation exists
136
- 2. **Project Context**: Read relevant project documentation before starting work
137
- - Vision and roadmap for understanding project goals
138
- - Tech stack for understanding technology constraints
139
- - Architecture for understanding system design
140
- 3. **Standards**: Reference appropriate standards when writing code
141
- - Global standards apply to all code
142
- - Domain-specific standards (frontend/backend/testing) apply to relevant code
143
- 4. **Keep Updated**: Update documentation when making significant changes
144
- - Update project docs when goals, tech stack, or architecture changes
145
- - Update standards when team conventions evolve
146
- - Update INDEX.md when adding or removing documentation
147
- 5. **Customize**: Adapt all documentation to your project's specific needs
148
- - Project documentation should reflect your actual project
149
- - Standards should reflect your team's conventions
150
- - Both should be version-controlled and reviewed regularly
151
-
152
- ## Updating Documentation
153
-
154
- ### When to Update
155
-
156
- - **Project docs**: When project goals, tech stack, or architecture changes
157
- - **Standards**: When team conventions evolve or new patterns are adopted
158
- - **INDEX.md**: When adding, removing, or significantly changing documentation
159
-
160
- ### How to Update
161
-
162
- 1. Edit the relevant documentation file directly
163
- 2. Update INDEX.md if the file's purpose or description changes
164
- 3. Ensure AGENTS.md still references this INDEX.md
165
- 4. Commit changes to version control
166
- 5. Notify the team of significant documentation changes
167
-
168
- ### Getting Help
169
-
170
- Use the Documentation Manager skill to:
171
-
172
- - Initialize documentation in a new project
173
- - Add new documentation files
174
- - Update existing documentation
175
- - Validate documentation consistency
176
- - Manage INDEX.md automatically
177
- - Ensure AGENTS.md integration
178
-
179
- ---
180
-
181
- ## Documentation Priority
182
-
183
- When making development decisions, follow this priority order:
184
-
185
- 1. **Project documentation** in `.owflow/docs/` (highest priority)
186
- - Represents team decisions and project-specific requirements
187
- 2. **Code patterns** visible in the codebase
188
- - Shows how the team actually implements things
189
- 3. **User's direct instructions**
190
- - Specific guidance for the current task
191
- 4. **General best practices** (lowest priority)
192
- - Default to industry standards when no specific guidance exists
193
-
194
- **The documentation in `.owflow/docs/` represents team decisions and should be followed unless the user explicitly overrides them.**
195
-
196
- ---
197
-
198
- **Last Generated**: [Automatically updated by Documentation Manager]
199
- **Maintained by**: Documentation Manager skill
1
+ # Documentation Index
2
+
3
+ **IMPORTANT**: Read this file at the beginning of any development task to understand available documentation and standards.
4
+
5
+ ## Quick Reference
6
+
7
+ ### Project Documentation
8
+
9
+ Project-level documentation covering vision, goals, architecture, and technology choices.
10
+
11
+ ### Technical Standards
12
+
13
+ Coding standards, conventions, and best practices organized by domain.
14
+
15
+ ---
16
+
17
+ ## Project Documentation
18
+
19
+ Located in `.owflow/docs/project/`
20
+
21
+ ### Vision (`project/vision.md`)
22
+
23
+ Defines the project's mission, goals, target users, and long-term vision. Read this to understand the "why" behind the project and align development decisions with project objectives.
24
+
25
+ ### Roadmap (`project/roadmap.md`)
26
+
27
+ Outlines development milestones, planned features, and timeline. Read this to understand project priorities and upcoming work.
28
+
29
+ ### Tech Stack (`project/tech-stack.md`)
30
+
31
+ Documents all technologies, frameworks, libraries, and tools used in the project, with rationale for each choice. Read this before adding new dependencies or making technology decisions.
32
+
33
+ ### Architecture (`project/architecture.md`)
34
+
35
+ Describes the system architecture, component structure, data flow, and design patterns. Read this to understand how the system is organized and how components interact.
36
+
37
+ ---
38
+
39
+ ## Technical Standards
40
+
41
+ ### Global Standards
42
+
43
+ Located in `.owflow/docs/standards/global/`
44
+
45
+ These standards apply across the entire codebase, regardless of frontend/backend context.
46
+
47
+ #### Error Handling (`standards/global/error-handling.md`)
48
+
49
+ Structured error types, error propagation patterns, user-facing vs internal error messages, try-catch placement guidelines, error logging conventions.
50
+
51
+ #### Validation (`standards/global/validation.md`)
52
+
53
+ Input validation at system boundaries, sanitization patterns, validation error message formatting, schema validation approach.
54
+
55
+ #### Conventions (`standards/global/conventions.md`)
56
+
57
+ Naming conventions (files, variables, functions, classes), file organization patterns, import ordering, code structure guidelines.
58
+
59
+ #### Coding Style (`standards/global/coding-style.md`)
60
+
61
+ Indentation and formatting rules, spacing conventions, line length limits, bracket style, consistent code readability patterns.
62
+
63
+ #### Commenting (`standards/global/commenting.md`)
64
+
65
+ When to comment (non-obvious logic only), documentation comment format, inline explanation guidelines, TODO/FIXME conventions.
66
+
67
+ #### Minimal Implementation (`standards/global/minimal-implementation.md`)
68
+
69
+ No speculative code, no unused methods, no "just in case" abstractions, YAGNI principle enforcement, lean code guidelines.
70
+
71
+ ---
72
+
73
+ ### Frontend Standards
74
+
75
+ Located in `.owflow/docs/standards/frontend/`
76
+
77
+ These standards apply to frontend code (UI components, client-side logic, styling).
78
+
79
+ #### CSS (`standards/frontend/css.md`)
80
+
81
+ CSS naming conventions, stylesheet organization, utility-first vs component styles, CSS variable usage, responsive styling patterns.
82
+
83
+ #### Components (`standards/frontend/components.md`)
84
+
85
+ Component structure and composition patterns, props design, lifecycle management, smart vs presentational separation.
86
+
87
+ #### Accessibility (`standards/frontend/accessibility.md`)
88
+
89
+ Keyboard navigation requirements, screen reader support, ARIA attribute usage, WCAG compliance level, focus management patterns.
90
+
91
+ #### Responsive Design (`standards/frontend/responsive.md`)
92
+
93
+ Breakpoint definitions, mobile-first approach, responsive layout patterns, touch target sizing, viewport considerations.
94
+
95
+ ---
96
+
97
+ ### Backend Standards
98
+
99
+ Located in `.owflow/docs/standards/backend/`
100
+
101
+ These standards apply to backend code (APIs, services, data layer).
102
+
103
+ #### API Design (`standards/backend/api.md`)
104
+
105
+ REST endpoint naming, request/response format conventions, versioning strategy, error response structure, pagination patterns.
106
+
107
+ #### Models (`standards/backend/models.md`)
108
+
109
+ Data model structure, schema conventions, business logic placement, relationship patterns, model validation rules.
110
+
111
+ #### Queries (`standards/backend/queries.md`)
112
+
113
+ Query optimization patterns, N+1 prevention, index usage guidelines, query builder conventions, raw query policies.
114
+
115
+ #### Migrations (`standards/backend/migrations.md`)
116
+
117
+ Migration naming conventions, schema change patterns, data migration approach, rollback requirements, migration testing.
118
+
119
+ ---
120
+
121
+ ### Testing Standards
122
+
123
+ Located in `.owflow/docs/standards/testing/`
124
+
125
+ These standards apply to all testing code (unit, integration, E2E).
126
+
127
+ #### Test Writing (`standards/testing/test-writing.md`)
128
+
129
+ Test naming conventions, test file organization, arrange-act-assert structure, mocking guidelines, coverage expectations, test data management.
130
+
131
+ ---
132
+
133
+ ## How to Use This Documentation
134
+
135
+ 1. **Start Here**: Always read this INDEX.md first to understand what documentation exists
136
+ 2. **Project Context**: Read relevant project documentation before starting work
137
+ - Vision and roadmap for understanding project goals
138
+ - Tech stack for understanding technology constraints
139
+ - Architecture for understanding system design
140
+ 3. **Standards**: Reference appropriate standards when writing code
141
+ - Global standards apply to all code
142
+ - Domain-specific standards (frontend/backend/testing) apply to relevant code
143
+ 4. **Keep Updated**: Update documentation when making significant changes
144
+ - Update project docs when goals, tech stack, or architecture changes
145
+ - Update standards when team conventions evolve
146
+ - Update INDEX.md when adding or removing documentation
147
+ 5. **Customize**: Adapt all documentation to your project's specific needs
148
+ - Project documentation should reflect your actual project
149
+ - Standards should reflect your team's conventions
150
+ - Both should be version-controlled and reviewed regularly
151
+
152
+ ## Updating Documentation
153
+
154
+ ### When to Update
155
+
156
+ - **Project docs**: When project goals, tech stack, or architecture changes
157
+ - **Standards**: When team conventions evolve or new patterns are adopted
158
+ - **INDEX.md**: When adding, removing, or significantly changing documentation
159
+
160
+ ### How to Update
161
+
162
+ 1. Edit the relevant documentation file directly
163
+ 2. Update INDEX.md if the file's purpose or description changes
164
+ 3. Ensure AGENTS.md still references this INDEX.md
165
+ 4. Commit changes to version control
166
+ 5. Notify the team of significant documentation changes
167
+
168
+ ### Getting Help
169
+
170
+ Use the Documentation Manager skill to:
171
+
172
+ - Initialize documentation in a new project
173
+ - Add new documentation files
174
+ - Update existing documentation
175
+ - Validate documentation consistency
176
+ - Manage INDEX.md automatically
177
+ - Ensure AGENTS.md integration
178
+
179
+ ---
180
+
181
+ ## Documentation Priority
182
+
183
+ When making development decisions, follow this priority order:
184
+
185
+ 1. **Project documentation** in `.owflow/docs/` (highest priority)
186
+ - Represents team decisions and project-specific requirements
187
+ 2. **Code patterns** visible in the codebase
188
+ - Shows how the team actually implements things
189
+ 3. **User's direct instructions**
190
+ - Specific guidance for the current task
191
+ 4. **General best practices** (lowest priority)
192
+ - Default to industry standards when no specific guidance exists
193
+
194
+ **The documentation in `.owflow/docs/` represents team decisions and should be followed unless the user explicitly overrides them.**
195
+
196
+ ---
197
+
198
+ **Last Generated**: [Automatically updated by Documentation Manager]
199
+ **Maintained by**: Documentation Manager skill
@@ -1,25 +1,25 @@
1
- ## API Design
2
-
3
- ### RESTful Principles
4
- Use resource-based URLs with appropriate HTTP methods (GET, POST, PUT, PATCH, DELETE).
5
-
6
- ### Consistent Naming
7
- Use lowercase, hyphenated or underscored names consistently across endpoints.
8
-
9
- ### Versioning
10
- Implement versioning (URL path or headers) to manage breaking changes.
11
-
12
- ### Plural Nouns
13
- Use plural nouns for resources (`/users`, `/products`).
14
-
15
- ### Limited Nesting
16
- Keep URL nesting to 2-3 levels maximum for readability.
17
-
18
- ### Query Parameters
19
- Use query parameters for filtering, sorting, and pagination.
20
-
21
- ### Proper Status Codes
22
- Return appropriate HTTP status codes (200, 201, 400, 404, 500).
23
-
24
- ### Rate Limit Headers
25
- Include rate limit information in response headers.
1
+ ## API Design
2
+
3
+ ### RESTful Principles
4
+ Use resource-based URLs with appropriate HTTP methods (GET, POST, PUT, PATCH, DELETE).
5
+
6
+ ### Consistent Naming
7
+ Use lowercase, hyphenated or underscored names consistently across endpoints.
8
+
9
+ ### Versioning
10
+ Implement versioning (URL path or headers) to manage breaking changes.
11
+
12
+ ### Plural Nouns
13
+ Use plural nouns for resources (`/users`, `/products`).
14
+
15
+ ### Limited Nesting
16
+ Keep URL nesting to 2-3 levels maximum for readability.
17
+
18
+ ### Query Parameters
19
+ Use query parameters for filtering, sorting, and pagination.
20
+
21
+ ### Proper Status Codes
22
+ Return appropriate HTTP status codes (200, 201, 400, 404, 500).
23
+
24
+ ### Rate Limit Headers
25
+ Include rate limit information in response headers.
@@ -1,22 +1,22 @@
1
- ## Database Migrations
2
-
3
- ### Reversible
4
- Always implement rollback methods for safe migration reversals.
5
-
6
- ### Small and Focused
7
- Keep each migration to a single logical change.
8
-
9
- ### Zero-Downtime Awareness
10
- Consider deployment order and backward compatibility for high-availability systems.
11
-
12
- ### Separate Schema and Data
13
- Keep schema changes separate from data migrations for safer rollbacks.
14
-
15
- ### Careful Indexing
16
- Create indexes on large tables carefully, using concurrent options when available.
17
-
18
- ### Descriptive Names
19
- Use names that indicate what the migration does.
20
-
21
- ### Version Control
22
- Commit migrations; never modify existing ones after deployment.
1
+ ## Database Migrations
2
+
3
+ ### Reversible
4
+ Always implement rollback methods for safe migration reversals.
5
+
6
+ ### Small and Focused
7
+ Keep each migration to a single logical change.
8
+
9
+ ### Zero-Downtime Awareness
10
+ Consider deployment order and backward compatibility for high-availability systems.
11
+
12
+ ### Separate Schema and Data
13
+ Keep schema changes separate from data migrations for safer rollbacks.
14
+
15
+ ### Careful Indexing
16
+ Create indexes on large tables carefully, using concurrent options when available.
17
+
18
+ ### Descriptive Names
19
+ Use names that indicate what the migration does.
20
+
21
+ ### Version Control
22
+ Commit migrations; never modify existing ones after deployment.
@@ -1,25 +1,25 @@
1
- ## Models
2
-
3
- ### Clear Naming
4
- Use singular names for models and plural for tables (or follow framework conventions).
5
-
6
- ### Timestamps
7
- Include created and updated timestamps for auditing and debugging.
8
-
9
- ### Database Constraints
10
- Enforce data rules at the database level (NOT NULL, UNIQUE, foreign keys).
11
-
12
- ### Appropriate Types
13
- Choose data types that match purpose and size requirements.
14
-
15
- ### Index Foreign Keys
16
- Index foreign key columns and frequently queried fields.
17
-
18
- ### Multi-Layer Validation
19
- Validate at both model and database levels for defense in depth.
20
-
21
- ### Clear Relationships
22
- Define relationships with appropriate cascade behaviors and naming.
23
-
24
- ### Practical Normalization
25
- Balance normalization with query performance needs.
1
+ ## Models
2
+
3
+ ### Clear Naming
4
+ Use singular names for models and plural for tables (or follow framework conventions).
5
+
6
+ ### Timestamps
7
+ Include created and updated timestamps for auditing and debugging.
8
+
9
+ ### Database Constraints
10
+ Enforce data rules at the database level (NOT NULL, UNIQUE, foreign keys).
11
+
12
+ ### Appropriate Types
13
+ Choose data types that match purpose and size requirements.
14
+
15
+ ### Index Foreign Keys
16
+ Index foreign key columns and frequently queried fields.
17
+
18
+ ### Multi-Layer Validation
19
+ Validate at both model and database levels for defense in depth.
20
+
21
+ ### Clear Relationships
22
+ Define relationships with appropriate cascade behaviors and naming.
23
+
24
+ ### Practical Normalization
25
+ Balance normalization with query performance needs.
@@ -1,22 +1,22 @@
1
- ## Database Queries
2
-
3
- ### Parameterized Queries
4
- Always use parameterized queries or ORM methods; never interpolate user input into SQL.
5
-
6
- ### Avoid N+1
7
- Use eager loading or joins to fetch related data in one query.
8
-
9
- ### Select Only Needed Columns
10
- Request only the columns you need rather than SELECT *.
11
-
12
- ### Index Strategic Columns
13
- Index columns used in WHERE, JOIN, and ORDER BY clauses.
14
-
15
- ### Transactions
16
- Wrap related operations in transactions to maintain consistency.
17
-
18
- ### Query Timeouts
19
- Set timeouts to prevent runaway queries from impacting performance.
20
-
21
- ### Cache Expensive Queries
22
- Cache results of complex or frequent queries when appropriate.
1
+ ## Database Queries
2
+
3
+ ### Parameterized Queries
4
+ Always use parameterized queries or ORM methods; never interpolate user input into SQL.
5
+
6
+ ### Avoid N+1
7
+ Use eager loading or joins to fetch related data in one query.
8
+
9
+ ### Select Only Needed Columns
10
+ Request only the columns you need rather than SELECT *.
11
+
12
+ ### Index Strategic Columns
13
+ Index columns used in WHERE, JOIN, and ORDER BY clauses.
14
+
15
+ ### Transactions
16
+ Wrap related operations in transactions to maintain consistency.
17
+
18
+ ### Query Timeouts
19
+ Set timeouts to prevent runaway queries from impacting performance.
20
+
21
+ ### Cache Expensive Queries
22
+ Cache results of complex or frequent queries when appropriate.
@@ -1,25 +1,25 @@
1
- ## Accessibility
2
-
3
- ### Semantic HTML
4
- Use appropriate elements (nav, main, button) that convey meaning to assistive technologies.
5
-
6
- ### Keyboard Navigation
7
- Make all interactive elements accessible via keyboard with visible focus indicators.
8
-
9
- ### Color Contrast
10
- Maintain 4.5:1 contrast for normal text; don't rely solely on color to convey information.
11
-
12
- ### Alt Text and Labels
13
- Provide descriptive alt text for images and labels for form inputs.
14
-
15
- ### Screen Reader Testing
16
- Verify all views work with screen readers.
17
-
18
- ### ARIA When Needed
19
- Use ARIA attributes to enhance complex components when semantic HTML isn't enough.
20
-
21
- ### Heading Structure
22
- Use heading levels (h1-h6) in proper order for clear document outline.
23
-
24
- ### Focus Management
25
- Manage focus appropriately in dynamic content, modals, and SPAs.
1
+ ## Accessibility
2
+
3
+ ### Semantic HTML
4
+ Use appropriate elements (nav, main, button) that convey meaning to assistive technologies.
5
+
6
+ ### Keyboard Navigation
7
+ Make all interactive elements accessible via keyboard with visible focus indicators.
8
+
9
+ ### Color Contrast
10
+ Maintain 4.5:1 contrast for normal text; don't rely solely on color to convey information.
11
+
12
+ ### Alt Text and Labels
13
+ Provide descriptive alt text for images and labels for form inputs.
14
+
15
+ ### Screen Reader Testing
16
+ Verify all views work with screen readers.
17
+
18
+ ### ARIA When Needed
19
+ Use ARIA attributes to enhance complex components when semantic HTML isn't enough.
20
+
21
+ ### Heading Structure
22
+ Use heading levels (h1-h6) in proper order for clear document outline.
23
+
24
+ ### Focus Management
25
+ Manage focus appropriately in dynamic content, modals, and SPAs.