owflow 0.1.1 → 0.1.2
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/README.md +8 -1
- package/dist/agents/bottleneck-analyzer.md +329 -0
- package/dist/agents/code-quality-pragmatist.md +354 -0
- package/dist/agents/code-reviewer.md +239 -0
- package/dist/agents/codebase-analysis-reporter.md +246 -0
- package/dist/agents/docs-operator.md +23 -0
- package/dist/agents/e2e-test-verifier.md +448 -0
- package/dist/agents/gap-analyzer.md +502 -0
- package/dist/agents/implementation-completeness-checker.md +220 -0
- package/dist/agents/implementation-planner.md +309 -0
- package/dist/agents/information-gatherer.md +691 -0
- package/dist/agents/production-readiness-checker.md +279 -0
- package/dist/agents/project-analyzer.md +404 -0
- package/dist/agents/reality-assessor.md +366 -0
- package/dist/agents/research-planner.md +447 -0
- package/dist/agents/research-synthesizer.md +401 -0
- package/dist/agents/solution-brainstormer.md +257 -0
- package/dist/agents/solution-designer.md +372 -0
- package/dist/agents/spec-auditor.md +298 -0
- package/dist/agents/specification-creator.md +334 -0
- package/dist/agents/task-classifier.md +462 -0
- package/dist/agents/task-group-implementer.md +284 -0
- package/dist/agents/test-suite-runner.md +195 -0
- package/dist/agents/ui-mockup-generator.md +369 -0
- package/dist/agents/user-docs-generator.md +509 -0
- package/dist/commands/development.md +37 -0
- package/dist/commands/flow-init.md +37 -0
- package/dist/commands/migration.md +37 -0
- package/dist/commands/performance.md +37 -0
- package/dist/commands/product-design.md +37 -0
- package/dist/commands/quick-bugfix.md +37 -0
- package/dist/commands/quick-dev.md +140 -0
- package/dist/commands/quick-plan.md +132 -0
- package/dist/commands/research.md +37 -0
- package/dist/commands/reviews-code.md +90 -0
- package/dist/commands/reviews-pragmatic.md +99 -0
- package/dist/commands/reviews-production-readiness.md +113 -0
- package/dist/commands/reviews-reality-check.md +110 -0
- package/dist/commands/reviews-spec-audit.md +114 -0
- package/dist/commands/standards-discover.md +37 -0
- package/dist/commands/standards-update.md +37 -0
- package/dist/commands/work.md +284 -0
- package/dist/skills/codebase-analyzer/SKILL.md +162 -0
- package/dist/skills/codebase-analyzer/references/code-analysis.md +63 -0
- package/dist/skills/codebase-analyzer/references/combined.md +31 -0
- package/dist/skills/codebase-analyzer/references/context-discovery.md +63 -0
- package/dist/skills/codebase-analyzer/references/file-discovery.md +51 -0
- package/dist/skills/codebase-analyzer/references/migration-target.md +23 -0
- package/dist/skills/codebase-analyzer/references/pattern-mining.md +22 -0
- package/dist/skills/development/SKILL.md +669 -0
- package/dist/skills/docs-manager/SKILL.md +379 -0
- package/dist/skills/docs-manager/docs/INDEX.md +199 -0
- package/dist/skills/docs-manager/docs/standards/backend/api.md +25 -0
- package/dist/skills/docs-manager/docs/standards/backend/migrations.md +22 -0
- package/dist/skills/docs-manager/docs/standards/backend/models.md +25 -0
- package/dist/skills/docs-manager/docs/standards/backend/queries.md +22 -0
- package/dist/skills/docs-manager/docs/standards/frontend/accessibility.md +25 -0
- package/dist/skills/docs-manager/docs/standards/frontend/components.md +28 -0
- package/dist/skills/docs-manager/docs/standards/frontend/css.md +16 -0
- package/dist/skills/docs-manager/docs/standards/frontend/responsive.md +28 -0
- package/dist/skills/docs-manager/docs/standards/global/coding-style.md +25 -0
- package/dist/skills/docs-manager/docs/standards/global/commenting.md +10 -0
- package/dist/skills/docs-manager/docs/standards/global/conventions.md +31 -0
- package/dist/skills/docs-manager/docs/standards/global/error-handling.md +22 -0
- package/dist/skills/docs-manager/docs/standards/global/minimal-implementation.md +22 -0
- package/dist/skills/docs-manager/docs/standards/global/validation.md +28 -0
- package/dist/skills/docs-manager/docs/standards/testing/test-writing.md +25 -0
- package/dist/skills/docs-manager/references/claude-md-template.md +29 -0
- package/dist/skills/docs-manager/references/index-md-template.md +73 -0
- package/dist/skills/flow-init/SKILL.md +198 -0
- package/dist/skills/flow-init/references/architecture-template.md +45 -0
- package/dist/skills/flow-init/references/roadmap-templates.md +93 -0
- package/dist/skills/flow-init/references/tech-stack-template.md +70 -0
- package/dist/skills/flow-init/references/vision-templates.md +75 -0
- package/dist/skills/implementation-plan-executor/SKILL.md +378 -0
- package/dist/skills/implementation-verifier/SKILL.md +307 -0
- package/dist/skills/migration/SKILL.md +380 -0
- package/dist/skills/migration/references/migration-strategies.md +397 -0
- package/dist/skills/migration/references/migration-types.md +437 -0
- package/dist/skills/orchestrator-framework/SKILL.md +65 -0
- package/dist/skills/orchestrator-framework/references/orchestrator-creation-checklist.md +47 -0
- package/dist/skills/orchestrator-framework/references/orchestrator-patterns.md +329 -0
- package/dist/skills/performance/SKILL.md +418 -0
- package/dist/skills/performance/references/performance-optimization-guide.md +365 -0
- package/dist/skills/product-design/SKILL.md +843 -0
- package/dist/skills/product-design/references/characteristic-detection.md +92 -0
- package/dist/skills/product-design/references/interaction-patterns.md +206 -0
- package/dist/skills/product-design/references/visual-companion.md +190 -0
- package/dist/skills/product-design/server/index.ts +359 -0
- package/dist/skills/product-design/server/template.html +256 -0
- package/dist/skills/quick-bugfix/SKILL.md +241 -0
- package/dist/skills/research/SKILL.md +493 -0
- package/dist/skills/research/references/brainstorming-techniques.md +84 -0
- package/dist/skills/research/references/design-techniques.md +40 -0
- package/dist/skills/research/references/research-methodologies.md +710 -0
- package/dist/skills/standards-discover/SKILL.md +236 -0
- package/dist/skills/standards-discover/references/aggregation-strategy.md +76 -0
- package/dist/skills/standards-discover/references/code-pattern-prompt.md +68 -0
- package/dist/skills/standards-discover/references/config-analyzer-prompt.md +67 -0
- package/dist/skills/standards-discover/references/docs-extractor-prompt.md +65 -0
- package/dist/skills/standards-discover/references/external-analyzer-prompt.md +75 -0
- package/dist/skills/standards-update/SKILL.md +159 -0
- package/package.json +7 -6
|
@@ -0,0 +1,379 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: docs-manager
|
|
3
|
+
description: Internal engine for managing project documentation and technical standards in .owflow/docs/. Handles file operations, INDEX.md generation, and AGENTS.md integration. Invoked by flow-init, standards-update, and standards-discover skills.
|
|
4
|
+
user-invocable: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Documentation Manager (Internal Engine)
|
|
8
|
+
|
|
9
|
+
Internal skill that manages documentation file operations in `.owflow/docs/`. Not directly user-invocable — called by `flow-init`, `standards-update`, and `standards-discover` skills.
|
|
10
|
+
|
|
11
|
+
## Core Principles
|
|
12
|
+
|
|
13
|
+
- **Project documentation is source of truth** — plugin-bundled docs are baseline/reference only
|
|
14
|
+
- **INDEX.md is the master map** — always kept up-to-date after changes
|
|
15
|
+
- **AGENTS.md integration is mandatory** — ensures AI reads documentation
|
|
16
|
+
|
|
17
|
+
## Documentation Structure
|
|
18
|
+
|
|
19
|
+
```
|
|
20
|
+
.owflow/docs/
|
|
21
|
+
├── INDEX.md # Master index - READ THIS FIRST
|
|
22
|
+
├── project/ # Project-level documentation (generated by flow-init, not copied from templates)
|
|
23
|
+
│ ├── vision.md # Project vision and goals
|
|
24
|
+
│ ├── roadmap.md # Development roadmap
|
|
25
|
+
│ ├── tech-stack.md # Technology choices and rationale
|
|
26
|
+
│ └── architecture.md # System architecture (optional)
|
|
27
|
+
└── standards/ # Technical standards and conventions
|
|
28
|
+
├── global/ # Language-agnostic standards
|
|
29
|
+
│ ├── error-handling.md
|
|
30
|
+
│ ├── validation.md
|
|
31
|
+
│ ├── conventions.md
|
|
32
|
+
│ ├── coding-style.md
|
|
33
|
+
│ └── commenting.md
|
|
34
|
+
├── frontend/ # Frontend-specific standards
|
|
35
|
+
│ ├── css.md
|
|
36
|
+
│ ├── components.md
|
|
37
|
+
│ ├── accessibility.md
|
|
38
|
+
│ └── responsive.md
|
|
39
|
+
├── backend/ # Backend-specific standards
|
|
40
|
+
│ ├── api.md
|
|
41
|
+
│ ├── models.md
|
|
42
|
+
│ ├── queries.md
|
|
43
|
+
│ └── migrations.md
|
|
44
|
+
└── testing/ # Testing standards
|
|
45
|
+
└── test-writing.md
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Standard File Conventions
|
|
49
|
+
|
|
50
|
+
Standard files follow the structure `standards/[category]/[topic].md`:
|
|
51
|
+
|
|
52
|
+
- **Category** = domain folder (global, frontend, backend, testing, or custom)
|
|
53
|
+
- **Topic file** = contains multiple related standards
|
|
54
|
+
|
|
55
|
+
**Format**: Each file uses `## Topic` as the file heading, with `### Standard Name` for each individual standard. Each standard has a 1-10 line description (excluding code snippets) and an optional brief code example (under 10 lines).
|
|
56
|
+
|
|
57
|
+
**Conciseness**: Standards are quick-reference conventions, not tutorials. If a file grows unwieldy, split into focused sub-topic files.
|
|
58
|
+
|
|
59
|
+
**Why ### per standard**: Each standard as a discrete section makes it easier for agents to find, update, and reference individually — no need to parse bullet lists.
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
## Bundled Resources
|
|
64
|
+
|
|
65
|
+
This skill bundles the following resources within the plugin:
|
|
66
|
+
|
|
67
|
+
- **Standards Directory**: Contains baseline technical standards organized by category:
|
|
68
|
+
- `global/` - Global standards (error handling, validation, conventions, etc.)
|
|
69
|
+
- `frontend/` - Frontend-specific standards (CSS, components, accessibility, etc.)
|
|
70
|
+
- `backend/` - Backend-specific standards (API design, database, queries, etc.)
|
|
71
|
+
- `testing/` - Testing standards (test writing, coverage, etc.)
|
|
72
|
+
- **INDEX.md Template**: Master template for documentation index
|
|
73
|
+
|
|
74
|
+
## Location Reference
|
|
75
|
+
|
|
76
|
+
- **Plugin bundles** (read-only baseline): This skill's `docs/` subdirectory within the plugin
|
|
77
|
+
- **Project documentation** (source of truth): `.owflow/docs/` in the project root
|
|
78
|
+
- **Project configuration**: `AGENTS.md` in the project root
|
|
79
|
+
|
|
80
|
+
## Capabilities
|
|
81
|
+
|
|
82
|
+
### 1. Initialize Documentation in Project
|
|
83
|
+
|
|
84
|
+
Use this when a project doesn't have `.owflow/docs/` or needs documentation for the first time. This is a **one-time baseline setup** that gives the project a starting point.
|
|
85
|
+
|
|
86
|
+
**IMPORTANT**: This operation accepts an optional `standards_selection` parameter (array of standard categories) to control which standards to initialize. If not provided, all standards are copied (backward compatible). It also accepts an optional `standards_source_path` parameter to copy standards from an external project instead of the bundled defaults.
|
|
87
|
+
|
|
88
|
+
**What to do:**
|
|
89
|
+
|
|
90
|
+
1. Check if `.owflow/docs/` exists in the project root
|
|
91
|
+
2. If it exists, warn the user that initialization will overwrite existing documentation and ask for confirmation
|
|
92
|
+
3. Create the directory structure based on standards_selection:
|
|
93
|
+
```
|
|
94
|
+
.owflow/docs/
|
|
95
|
+
├── project/
|
|
96
|
+
└── standards/
|
|
97
|
+
├── global/ (if 'global' in standards_selection or no selection provided)
|
|
98
|
+
├── frontend/ (if 'frontend' in standards_selection or no selection provided)
|
|
99
|
+
├── backend/ (if 'backend' in standards_selection or no selection provided)
|
|
100
|
+
└── testing/ (if 'testing' in standards_selection or no selection provided)
|
|
101
|
+
```
|
|
102
|
+
4. Copy standards to the project's `.owflow/docs/standards/` directory. **Source selection**: If `standards_source_path` is provided, copy from that external path. Otherwise, copy from this skill's bundled `docs/standards/` directory:
|
|
103
|
+
- **Project documentation**: Do NOT copy project templates — only create the `project/` directory. Project documentation files (vision, roadmap, tech-stack, architecture) are generated by the calling skill (e.g., flow-init) using analyzer data, not copied as placeholder templates.
|
|
104
|
+
- **Standards**: Only copy selected standard categories based on standards_selection parameter:
|
|
105
|
+
- If `standards_selection` is empty or not provided: Copy ALL standards (backward compatible)
|
|
106
|
+
- If `standards_selection` is provided: Only copy specified categories
|
|
107
|
+
- Examples:
|
|
108
|
+
- `['global', 'frontend', 'testing']` → Copy only these three categories
|
|
109
|
+
- `['global', 'backend', 'testing']` → Skip frontend standards
|
|
110
|
+
- `['global', 'testing']` → Only global and testing standards
|
|
111
|
+
5. Generate INDEX.md with entries for all copied documentation (see "Manage INDEX.md" operation):
|
|
112
|
+
- For skipped standard categories, add placeholder sections with "Not initialized - run standards discovery if needed"
|
|
113
|
+
- Example: If frontend standards are skipped, INDEX.md shows:
|
|
114
|
+
|
|
115
|
+
```markdown
|
|
116
|
+
### Frontend Standards
|
|
117
|
+
|
|
118
|
+
_Not initialized for this project. If you need frontend standards, you can:_
|
|
119
|
+
|
|
120
|
+
- _Add them manually using the docs-manager skill_
|
|
121
|
+
- _Run `/standards-discover --scope=frontend` to auto-discover_
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
6. **MANDATORY - Update AGENTS.md:**
|
|
125
|
+
- Check if `AGENTS.md` exists in the project root; if not, ask the user if they want to create it
|
|
126
|
+
- Add the documentation reference section (see "Manage AGENTS.md Integration" operation)
|
|
127
|
+
- Ensure it emphasizes reading INDEX.md at the beginning of any task
|
|
128
|
+
7. Inform the caller about the documentation structure created
|
|
129
|
+
|
|
130
|
+
**Parameters:**
|
|
131
|
+
|
|
132
|
+
- `standards_selection` (optional, array of strings): Standard categories to initialize
|
|
133
|
+
- Array of category names (e.g., `['global', 'frontend', 'backend', 'testing']`). Baseline categories: global, frontend, backend, testing. Custom categories are also supported.
|
|
134
|
+
- If omitted or empty: Initialize all baseline standards (backward compatible)
|
|
135
|
+
- If provided: Only initialize specified categories (creates directories for custom ones)
|
|
136
|
+
- `standards_source_path` (optional, string): Absolute path to an external standards directory (e.g., `/path/to/other-project/.owflow/docs/standards/`)
|
|
137
|
+
- If provided: Copy standards from this path instead of the bundled defaults
|
|
138
|
+
- If omitted: Copy from this skill's bundled `docs/standards/` directory (default behavior)
|
|
139
|
+
|
|
140
|
+
**Result:** The project now has baseline documentation in `.owflow/docs/`, a comprehensive INDEX.md, and AGENTS.md integration that ensures AI assistance is documentation-aware. Only selected standard categories are initialized.
|
|
141
|
+
|
|
142
|
+
**Important:** After this initial setup, the project's documentation becomes the source of truth. Teams should customize it for their specific needs.
|
|
143
|
+
|
|
144
|
+
**Note on Skipped Standards**: If standard categories are skipped during initialization, teams can add them later using:
|
|
145
|
+
|
|
146
|
+
- "Add Documentation File" operation to add specific standards
|
|
147
|
+
- `/standards-discover` command to auto-discover standards from codebase
|
|
148
|
+
|
|
149
|
+
---
|
|
150
|
+
|
|
151
|
+
### 2. Manage INDEX.md
|
|
152
|
+
|
|
153
|
+
Use this to create or update the INDEX.md file that serves as the master documentation map.
|
|
154
|
+
|
|
155
|
+
**What to do:**
|
|
156
|
+
|
|
157
|
+
1. Scan the `.owflow/docs/` directory structure
|
|
158
|
+
2. For each documentation file found:
|
|
159
|
+
- Read the file content to extract description
|
|
160
|
+
- Determine the file's purpose and category
|
|
161
|
+
- **For technical standards**: The description MUST enumerate the specific practices/conventions documented in the file, not just a generic category description.
|
|
162
|
+
3. Read `references/index-md-template.md` for the INDEX.md structure template
|
|
163
|
+
4. Generate INDEX.md by populating the template with discovered files and descriptions
|
|
164
|
+
5. Write the generated INDEX.md to `.owflow/docs/INDEX.md`
|
|
165
|
+
6. Verify that AGENTS.md references this index (see "Manage AGENTS.md Integration" operation)
|
|
166
|
+
|
|
167
|
+
**Result:** A comprehensive, up-to-date INDEX.md that provides a clear map of all project documentation.
|
|
168
|
+
|
|
169
|
+
---
|
|
170
|
+
|
|
171
|
+
### 3. Add Documentation File
|
|
172
|
+
|
|
173
|
+
Use this to add new documentation to the project, either from plugin baseline or custom.
|
|
174
|
+
|
|
175
|
+
**What to do:**
|
|
176
|
+
|
|
177
|
+
1. Determine the type of documentation to add:
|
|
178
|
+
- Project documentation (vision, roadmap, tech-stack, architecture, custom)
|
|
179
|
+
- Technical standard (any category under standards/)
|
|
180
|
+
2. If adding from plugin baseline:
|
|
181
|
+
- Check if the requested documentation exists in this skill's bundled `docs/` directory
|
|
182
|
+
- Copy it to the appropriate location in `.owflow/docs/`
|
|
183
|
+
3. If creating custom documentation:
|
|
184
|
+
- Ask for the category (project/ or standards/category/)
|
|
185
|
+
- Ask for the filename and purpose
|
|
186
|
+
- Create a template file with appropriate frontmatter and structure
|
|
187
|
+
4. Update INDEX.md to include the new documentation (see "Manage INDEX.md" operation)
|
|
188
|
+
5. If this is a technical standard and corresponds to a Claude Code Skill, ensure consistency
|
|
189
|
+
|
|
190
|
+
**Result:** New documentation is added to the project and indexed in INDEX.md.
|
|
191
|
+
|
|
192
|
+
---
|
|
193
|
+
|
|
194
|
+
### 4. Update Documentation
|
|
195
|
+
|
|
196
|
+
Use this to help the user update or modify existing project documentation.
|
|
197
|
+
|
|
198
|
+
**What to do:**
|
|
199
|
+
|
|
200
|
+
1. Accept the documentation identifier from the user (e.g., "project/vision", "standards/global/error-handling")
|
|
201
|
+
2. Check if the documentation exists in `.owflow/docs/`
|
|
202
|
+
3. If the documentation exists:
|
|
203
|
+
- Read the current documentation
|
|
204
|
+
- Ask the user what they want to change or update
|
|
205
|
+
- Help them edit the documentation file directly
|
|
206
|
+
- Optionally, show them the plugin's baseline version for reference if they ask
|
|
207
|
+
4. If the documentation doesn't exist:
|
|
208
|
+
- Offer to add it from the plugin baseline (see "Add Documentation File" operation)
|
|
209
|
+
- Or offer to help them create custom documentation from scratch
|
|
210
|
+
5. After updating:
|
|
211
|
+
- Check if INDEX.md needs updating (if the purpose/description changed significantly)
|
|
212
|
+
- If updating tech-stack.md or architecture.md, suggest reviewing AGENTS.md for consistency
|
|
213
|
+
6. For technical standards:
|
|
214
|
+
- If a corresponding Claude Code Skill exists, suggest reviewing it for consistency
|
|
215
|
+
- Standards should align with actual code patterns in the project
|
|
216
|
+
|
|
217
|
+
**Result:** Documentation is updated to reflect current project state and team decisions.
|
|
218
|
+
|
|
219
|
+
---
|
|
220
|
+
|
|
221
|
+
### 5. Use Plugin Documentation as Reference
|
|
222
|
+
|
|
223
|
+
Use this when a team wants to see the plugin's baseline documentation for reference, or reset specific docs to plugin defaults.
|
|
224
|
+
|
|
225
|
+
**What to do:**
|
|
226
|
+
|
|
227
|
+
1. Compare the documentation in this skill's bundled `docs/` directory with the project's `.owflow/docs/` directory to identify differences
|
|
228
|
+
2. Show the user which documents differ and how they differ
|
|
229
|
+
3. Explain that plugin documentation is baseline/reference only, and project documentation is superior
|
|
230
|
+
4. **WARNING**: Copying plugin documentation to the project will overwrite any project-specific customizations
|
|
231
|
+
5. Ask the user if they want to:
|
|
232
|
+
- View the differences for reference only (no changes)
|
|
233
|
+
- Reset specific documentation to plugin baseline (selective overwrite)
|
|
234
|
+
- Reset all documentation to plugin baseline (full overwrite - rarely recommended)
|
|
235
|
+
6. If the user chooses to copy any documentation:
|
|
236
|
+
- Copy the selected files from this skill's bundled `docs/` directory to the project's `.owflow/docs/` directory
|
|
237
|
+
- Update INDEX.md to reflect any changes
|
|
238
|
+
- Review AGENTS.md for any necessary updates
|
|
239
|
+
|
|
240
|
+
**Important:** This operation should be used rarely, mainly when a team wants to reset to baseline. Project documentation is the source of truth and should be maintained by the team.
|
|
241
|
+
|
|
242
|
+
**Result:** User can reference plugin baseline documentation and optionally reset specific docs to plugin versions.
|
|
243
|
+
|
|
244
|
+
---
|
|
245
|
+
|
|
246
|
+
### 6. List Available Documentation
|
|
247
|
+
|
|
248
|
+
Use this to show what documentation is bundled with this plugin and their installation status in the project.
|
|
249
|
+
|
|
250
|
+
**What to do:**
|
|
251
|
+
|
|
252
|
+
1. List all documentation in this skill's bundled `docs/` directory, organized by category
|
|
253
|
+
2. For each bundled document:
|
|
254
|
+
- Show the category and name
|
|
255
|
+
- Check if it exists in the project at `.owflow/docs/[category]/[name].md`
|
|
256
|
+
- Show installation status (bundled only, installed, or customized)
|
|
257
|
+
- If installed, show whether it differs from the baseline (customized)
|
|
258
|
+
3. Show whether INDEX.md exists and is up-to-date
|
|
259
|
+
4. Show whether AGENTS.md has documentation integration
|
|
260
|
+
5. Remind the user that plugin documentation is baseline/reference only, and project documentation (if installed) is the source of truth
|
|
261
|
+
|
|
262
|
+
**Result:** The user sees a complete inventory of available baseline documentation and their installation status in the current project.
|
|
263
|
+
|
|
264
|
+
---
|
|
265
|
+
|
|
266
|
+
### 7. Manage AGENTS.md Integration
|
|
267
|
+
|
|
268
|
+
Use this to ensure the project's AGENTS.md properly integrates with the documentation system, encouraging AI to read and use the documentation.
|
|
269
|
+
|
|
270
|
+
**What to do:**
|
|
271
|
+
|
|
272
|
+
1. Check if `AGENTS.md` exists in the project root
|
|
273
|
+
2. If it doesn't exist, ask the user if they want to create it
|
|
274
|
+
3. Look for a documentation reference section in AGENTS.md
|
|
275
|
+
4. If the section doesn't exist or is incomplete:
|
|
276
|
+
- Read `references/claude-md-template.md` for the template
|
|
277
|
+
- Add the template section to AGENTS.md
|
|
278
|
+
5. Ensure the documentation section is placed prominently in AGENTS.md (near the top)
|
|
279
|
+
6. Verify that the INDEX.md path is correct and the file exists
|
|
280
|
+
7. If `.owflow/docs/` doesn't exist, suggest running the initialization operation first
|
|
281
|
+
|
|
282
|
+
**Result:** AGENTS.md properly integrates with the documentation system, ensuring AI assistance is documentation-aware and follows team conventions.
|
|
283
|
+
|
|
284
|
+
---
|
|
285
|
+
|
|
286
|
+
### 8. Validate Documentation Consistency
|
|
287
|
+
|
|
288
|
+
Use this to check that documentation is consistent, up-to-date, and properly integrated.
|
|
289
|
+
|
|
290
|
+
**What to do:**
|
|
291
|
+
|
|
292
|
+
1. **Check structure:**
|
|
293
|
+
- Verify `.owflow/docs/` directory exists
|
|
294
|
+
- Verify all expected subdirectories exist (project/, standards/global/, etc.)
|
|
295
|
+
2. **Check INDEX.md:**
|
|
296
|
+
- Verify it exists and is readable
|
|
297
|
+
- Check that all files in `.owflow/docs/` are listed in INDEX.md
|
|
298
|
+
- Check that all files listed in INDEX.md actually exist
|
|
299
|
+
- Report any orphaned files or broken references
|
|
300
|
+
3. **Check AGENTS.md integration:**
|
|
301
|
+
- Verify AGENTS.md exists
|
|
302
|
+
- Verify it contains documentation reference section
|
|
303
|
+
- Verify it uses valid file reference format: @.owflow/docs/INDEX.md (with @ prefix, without backticks)
|
|
304
|
+
- Warn if using incorrect formats like `.owflow/docs/INDEX.md` or `@.owflow/docs/INDEX.md` (backticks)
|
|
305
|
+
4. **Check project documentation:**
|
|
306
|
+
- Verify critical files exist (vision.md, tech-stack.md)
|
|
307
|
+
- Check if they contain placeholder text vs. actual project information
|
|
308
|
+
- Warn if critical documentation is missing or empty
|
|
309
|
+
5. **Check standards consistency:**
|
|
310
|
+
- If Claude Code Skills exist, check if corresponding standards documentation exists
|
|
311
|
+
- If standards exist without skills, suggest creating skills (if appropriate)
|
|
312
|
+
- Report any inconsistencies
|
|
313
|
+
6. **Generate validation report:**
|
|
314
|
+
- Summary of documentation status
|
|
315
|
+
- List of issues found
|
|
316
|
+
- Recommendations for fixes
|
|
317
|
+
7. **Offer to fix issues:**
|
|
318
|
+
- Ask if the user wants to automatically fix found issues
|
|
319
|
+
- Fix missing INDEX.md entries
|
|
320
|
+
- Fix missing AGENTS.md integration
|
|
321
|
+
- Create missing directory structure
|
|
322
|
+
|
|
323
|
+
**Result:** A comprehensive validation report with optional automatic fixes for common issues.
|
|
324
|
+
|
|
325
|
+
---
|
|
326
|
+
|
|
327
|
+
## Usage Examples
|
|
328
|
+
|
|
329
|
+
**Initialize documentation in a new project:**
|
|
330
|
+
|
|
331
|
+
```
|
|
332
|
+
User: "Set up documentation for this project"
|
|
333
|
+
Claude: [Executes Initialize Documentation - creates structure, copies baseline docs, generates INDEX.md, updates AGENTS.md, gathers project info]
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
**Update project vision:**
|
|
337
|
+
|
|
338
|
+
```
|
|
339
|
+
User: "I want to update our project vision to include AI-first approach"
|
|
340
|
+
Claude: [Executes Update Documentation - reads current vision.md, helps user edit it, updates INDEX.md if needed]
|
|
341
|
+
```
|
|
342
|
+
|
|
343
|
+
**Add custom documentation:**
|
|
344
|
+
|
|
345
|
+
```
|
|
346
|
+
User: "Add documentation for our deployment process"
|
|
347
|
+
Claude: [Executes Add Documentation File - creates custom project/deployment.md, updates INDEX.md]
|
|
348
|
+
```
|
|
349
|
+
|
|
350
|
+
**Reference plugin baseline:**
|
|
351
|
+
|
|
352
|
+
```
|
|
353
|
+
User: "Show me the plugin's baseline error handling standard"
|
|
354
|
+
Claude: [Executes Use Plugin Documentation as Reference - shows plugin baseline, compares with project version, no changes unless user requests]
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
**Validate documentation:**
|
|
358
|
+
|
|
359
|
+
```
|
|
360
|
+
User: "Check if our documentation is complete and consistent"
|
|
361
|
+
Claude: [Executes Validate Documentation Consistency - checks structure, INDEX.md, AGENTS.md integration, generates report]
|
|
362
|
+
```
|
|
363
|
+
|
|
364
|
+
**Manage INDEX.md:**
|
|
365
|
+
|
|
366
|
+
```
|
|
367
|
+
User: "Rebuild the documentation index"
|
|
368
|
+
Claude: [Executes Manage INDEX.md - scans .owflow/docs/, regenerates comprehensive INDEX.md]
|
|
369
|
+
```
|
|
370
|
+
|
|
371
|
+
---
|
|
372
|
+
|
|
373
|
+
## Important Notes
|
|
374
|
+
|
|
375
|
+
- **Project documentation is source of truth** — plugin-bundled docs are baseline/reference only
|
|
376
|
+
- **INDEX.md must stay current** — regenerate after any documentation change
|
|
377
|
+
- **AGENTS.md integration is mandatory** — ensures AI reads documentation at task start
|
|
378
|
+
- **This skill is an internal engine** — called by flow-init, standards-update, and standards-discover. Not directly user-invocable.
|
|
379
|
+
- **CRITICAL: Return control after completion** — This is an internal sub-skill. After completing the requested operation, return control to the calling workflow. Do NOT treat completion of this skill as the end of the conversation turn — the parent skill has more steps to execute.
|
|
@@ -0,0 +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
|
|
@@ -0,0 +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.
|
|
@@ -0,0 +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.
|
|
@@ -0,0 +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.
|
|
@@ -0,0 +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.
|