owflow 0.1.1 → 0.1.3
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/index.js +3 -2
- 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 +44 -43
|
@@ -0,0 +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.
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
## Components
|
|
2
|
+
|
|
3
|
+
### Single Responsibility
|
|
4
|
+
Each component should do one thing well.
|
|
5
|
+
|
|
6
|
+
### Reusability
|
|
7
|
+
Design components to work across different contexts with configurable props.
|
|
8
|
+
|
|
9
|
+
### Composability
|
|
10
|
+
Build complex UIs by combining smaller components rather than creating monoliths.
|
|
11
|
+
|
|
12
|
+
### Clear Interface
|
|
13
|
+
Define explicit, documented props with sensible defaults.
|
|
14
|
+
|
|
15
|
+
### Encapsulation
|
|
16
|
+
Keep implementation details private; expose only what's necessary.
|
|
17
|
+
|
|
18
|
+
### Consistent Naming
|
|
19
|
+
Use descriptive names that indicate purpose and follow team conventions.
|
|
20
|
+
|
|
21
|
+
### Local State
|
|
22
|
+
Keep state as close to where it's used as possible; lift only when needed.
|
|
23
|
+
|
|
24
|
+
### Minimal Props
|
|
25
|
+
If a component needs many props, consider composition or splitting it.
|
|
26
|
+
|
|
27
|
+
### Documentation
|
|
28
|
+
Document usage, props, and examples to help team adoption.
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
## CSS
|
|
2
|
+
|
|
3
|
+
### Consistent Methodology
|
|
4
|
+
Stick to the project's chosen approach (Tailwind, BEM, CSS modules, etc.) across the entire codebase.
|
|
5
|
+
|
|
6
|
+
### Work With the Framework
|
|
7
|
+
Use framework patterns as intended rather than fighting them with excessive overrides.
|
|
8
|
+
|
|
9
|
+
### Design Tokens
|
|
10
|
+
Establish and document consistent values for colors, spacing, and typography.
|
|
11
|
+
|
|
12
|
+
### Minimize Custom CSS
|
|
13
|
+
Prefer framework utilities to reduce custom styling maintenance.
|
|
14
|
+
|
|
15
|
+
### Production Optimization
|
|
16
|
+
Use CSS purging or tree-shaking to remove unused styles.
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
## Responsive Design
|
|
2
|
+
|
|
3
|
+
### Mobile-First
|
|
4
|
+
Start with mobile layout and progressively enhance for larger screens.
|
|
5
|
+
|
|
6
|
+
### Standard Breakpoints
|
|
7
|
+
Use consistent breakpoints (mobile, tablet, desktop) across the application.
|
|
8
|
+
|
|
9
|
+
### Fluid Layouts
|
|
10
|
+
Use percentage-based widths and flexible containers that adapt to screen size.
|
|
11
|
+
|
|
12
|
+
### Relative Units
|
|
13
|
+
Prefer rem/em over fixed pixels for better scalability.
|
|
14
|
+
|
|
15
|
+
### Cross-Device Testing
|
|
16
|
+
Test across multiple screen sizes to ensure a balanced experience.
|
|
17
|
+
|
|
18
|
+
### Touch-Friendly
|
|
19
|
+
Size tap targets appropriately (minimum 44x44px) for mobile users.
|
|
20
|
+
|
|
21
|
+
### Mobile Performance
|
|
22
|
+
Optimize images and assets for mobile network conditions.
|
|
23
|
+
|
|
24
|
+
### Readable Typography
|
|
25
|
+
Maintain readable font sizes across all breakpoints.
|
|
26
|
+
|
|
27
|
+
### Content Priority
|
|
28
|
+
Show the most important content first on smaller screens.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
## Coding Style
|
|
2
|
+
|
|
3
|
+
### Naming Consistency
|
|
4
|
+
Follow established naming patterns for variables, functions, classes, and files throughout the project.
|
|
5
|
+
|
|
6
|
+
### Automatic Formatting
|
|
7
|
+
Use automated tools to enforce consistent indentation, spacing, and line breaks.
|
|
8
|
+
|
|
9
|
+
### Descriptive Names
|
|
10
|
+
Choose names that clearly communicate intent; avoid cryptic abbreviations or single-letter identifiers outside tight loops.
|
|
11
|
+
|
|
12
|
+
### Focused Functions
|
|
13
|
+
Write functions that do one thing well; smaller functions are easier to read, test, and maintain.
|
|
14
|
+
|
|
15
|
+
### Uniform Indentation
|
|
16
|
+
Standardize on spaces or tabs and enforce with editor/linter settings.
|
|
17
|
+
|
|
18
|
+
### No Dead Code
|
|
19
|
+
Remove unused imports, commented-out blocks, and orphaned functions instead of leaving them behind.
|
|
20
|
+
|
|
21
|
+
### No Backward Compatibility Unless Required
|
|
22
|
+
Avoid extra code paths for backward compatibility unless explicitly needed.
|
|
23
|
+
|
|
24
|
+
### DRY (Don't Repeat Yourself)
|
|
25
|
+
Extract repeated logic into reusable functions or modules.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
## Commenting
|
|
2
|
+
|
|
3
|
+
### Let Code Speak
|
|
4
|
+
Write code that explains itself through structure and naming.
|
|
5
|
+
|
|
6
|
+
### Comment Sparingly
|
|
7
|
+
Add brief comments only when the logic isn't self-evident from the code.
|
|
8
|
+
|
|
9
|
+
### No Change Comments
|
|
10
|
+
Avoid comments about recent fixes or changes; comments should be timeless explanations, not changelogs.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
## Development Conventions
|
|
2
|
+
|
|
3
|
+
### Predictable Structure
|
|
4
|
+
Organize files and directories in a logical, navigable layout.
|
|
5
|
+
|
|
6
|
+
### Up-to-Date Documentation
|
|
7
|
+
Keep README files current with setup steps, architecture overview, and contribution guidelines.
|
|
8
|
+
|
|
9
|
+
### Clean Version Control
|
|
10
|
+
Write clear commit messages, use feature branches, and add meaningful descriptions to pull requests.
|
|
11
|
+
|
|
12
|
+
### Environment Variables
|
|
13
|
+
Store configuration in environment variables; never commit secrets or API keys.
|
|
14
|
+
|
|
15
|
+
### Minimal Dependencies
|
|
16
|
+
Keep dependencies lean and up-to-date; document why major ones are included.
|
|
17
|
+
|
|
18
|
+
### Consistent Reviews
|
|
19
|
+
Follow a defined code review process with clear expectations for reviewers and authors.
|
|
20
|
+
|
|
21
|
+
### Testing Standards
|
|
22
|
+
Define required test coverage (unit, integration, etc.) before merging.
|
|
23
|
+
|
|
24
|
+
### Feature Flags
|
|
25
|
+
Use flags for incomplete features instead of long-lived branches.
|
|
26
|
+
|
|
27
|
+
### Changelog Updates
|
|
28
|
+
Maintain a changelog or release notes for significant changes.
|
|
29
|
+
|
|
30
|
+
### Build What's Needed
|
|
31
|
+
Avoid speculative code and "just in case" additions (see minimal-implementation.md).
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
## Error Handling
|
|
2
|
+
|
|
3
|
+
### Clear User Messages
|
|
4
|
+
Show helpful, actionable messages without exposing internal details or security-sensitive information.
|
|
5
|
+
|
|
6
|
+
### Fail Fast
|
|
7
|
+
Validate inputs and check preconditions early; reject invalid data before it causes deeper issues.
|
|
8
|
+
|
|
9
|
+
### Typed Exceptions
|
|
10
|
+
Use specific exception types instead of generic ones to enable precise error handling.
|
|
11
|
+
|
|
12
|
+
### Centralized Handling
|
|
13
|
+
Catch and process errors at appropriate boundaries (controllers, API layers) rather than scattering try-catch throughout.
|
|
14
|
+
|
|
15
|
+
### Graceful Degradation
|
|
16
|
+
When non-critical services fail, continue operating with reduced functionality rather than crashing entirely.
|
|
17
|
+
|
|
18
|
+
### Retry with Backoff
|
|
19
|
+
Use exponential backoff for transient failures when calling external services.
|
|
20
|
+
|
|
21
|
+
### Resource Cleanup
|
|
22
|
+
Always release resources (file handles, connections) in finally blocks or equivalent cleanup mechanisms.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
## Minimal Implementation
|
|
2
|
+
|
|
3
|
+
### Build What You Need
|
|
4
|
+
Create only methods, classes, and functions that will actually be called.
|
|
5
|
+
|
|
6
|
+
### Clear Purpose
|
|
7
|
+
Every method should either be called or improve code readability; nothing else.
|
|
8
|
+
|
|
9
|
+
### Delete Exploration Artifacts
|
|
10
|
+
Remove helper methods and utilities created during development that ended up unused.
|
|
11
|
+
|
|
12
|
+
### No Future Stubs
|
|
13
|
+
Avoid empty methods, placeholder functions, or interfaces "for future extensibility".
|
|
14
|
+
|
|
15
|
+
### No Speculative Abstractions
|
|
16
|
+
Skip factories, strategies, or adapters unless there's an immediate need.
|
|
17
|
+
|
|
18
|
+
### Review Before Commit
|
|
19
|
+
Verify all new methods have callers or serve a clear readability purpose before completing a task.
|
|
20
|
+
|
|
21
|
+
### Unused Code Is Debt
|
|
22
|
+
Remove dead code promptly; it confuses readers and adds maintenance burden.
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
## Validation
|
|
2
|
+
|
|
3
|
+
### Server-Side Always
|
|
4
|
+
Validate on the server; client-side validation alone is insufficient for security and data integrity.
|
|
5
|
+
|
|
6
|
+
### Client-Side for Feedback
|
|
7
|
+
Use client-side validation for immediate user feedback, but duplicate checks server-side.
|
|
8
|
+
|
|
9
|
+
### Validate Early
|
|
10
|
+
Check inputs as early as possible and reject invalid data before processing.
|
|
11
|
+
|
|
12
|
+
### Specific Errors
|
|
13
|
+
Provide clear, field-specific messages that help users correct their input.
|
|
14
|
+
|
|
15
|
+
### Allowlists Over Blocklists
|
|
16
|
+
Define what's allowed rather than trying to block everything else.
|
|
17
|
+
|
|
18
|
+
### Type and Format Checks
|
|
19
|
+
Validate data types, formats, ranges, and required fields systematically.
|
|
20
|
+
|
|
21
|
+
### Input Sanitization
|
|
22
|
+
Sanitize user input to prevent injection attacks (SQL, XSS, command injection).
|
|
23
|
+
|
|
24
|
+
### Business Rules
|
|
25
|
+
Validate business logic (sufficient balance, valid dates) at the appropriate layer.
|
|
26
|
+
|
|
27
|
+
### Consistent Enforcement
|
|
28
|
+
Apply validation uniformly across all entry points (forms, APIs, background jobs).
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
## Test Writing
|
|
2
|
+
|
|
3
|
+
### Test Behavior
|
|
4
|
+
Focus on what code does, not how it does it, to allow safe refactoring.
|
|
5
|
+
|
|
6
|
+
### Clear Names
|
|
7
|
+
Use descriptive names explaining what's tested and expected (`shouldReturnErrorWhenUserNotFound`).
|
|
8
|
+
|
|
9
|
+
### Mock External Dependencies
|
|
10
|
+
Isolate tests by mocking databases, APIs, and external services.
|
|
11
|
+
|
|
12
|
+
### Fast Execution
|
|
13
|
+
Keep unit tests fast (milliseconds) so developers run them frequently.
|
|
14
|
+
|
|
15
|
+
### Risk-Based Testing
|
|
16
|
+
Prioritize testing based on business criticality and likelihood of bugs.
|
|
17
|
+
|
|
18
|
+
### Balance Coverage and Velocity
|
|
19
|
+
Adjust test coverage based on project needs and team workflow.
|
|
20
|
+
|
|
21
|
+
### Critical Path Focus
|
|
22
|
+
Ensure core user workflows and critical business logic are well-tested.
|
|
23
|
+
|
|
24
|
+
### Appropriate Depth
|
|
25
|
+
Match edge case testing to the risk profile of the code.
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# AGENTS.md Documentation Section Template
|
|
2
|
+
|
|
3
|
+
Add this section to the project's `AGENTS.md` file. Place it prominently near the top. Verify the INDEX.md path is correct and the file exists before adding.
|
|
4
|
+
|
|
5
|
+
```markdown
|
|
6
|
+
## Coding Standards & Conventions
|
|
7
|
+
|
|
8
|
+
Read @.owflow/docs/INDEX.md before starting any task. It indexes the project's coding standards and conventions:
|
|
9
|
+
|
|
10
|
+
- Coding standards organized by domain (frontend, backend, testing, etc.)
|
|
11
|
+
- Project vision, tech stack, and architecture decisions
|
|
12
|
+
|
|
13
|
+
Follow standards in `.owflow/docs/standards/` when writing code — they represent team decisions. If standards conflict with the task, ask the user.
|
|
14
|
+
|
|
15
|
+
### Standards Evolution
|
|
16
|
+
|
|
17
|
+
When you notice recurring patterns, fixes, or conventions during implementation that aren't yet captured in standards — suggest adding them. Examples:
|
|
18
|
+
|
|
19
|
+
- A bug fix reveals a pattern that should be standardized (e.g., "always validate X before Y")
|
|
20
|
+
- PR review feedback identifies a convention the team wants enforced
|
|
21
|
+
- The same type of fix is needed across multiple files
|
|
22
|
+
- A new library/pattern is adopted that should be documented
|
|
23
|
+
|
|
24
|
+
When this happens, briefly suggest the standard to the user. If approved, invoke `/standards-update` with the identified pattern.
|
|
25
|
+
|
|
26
|
+
## owflow Workflows
|
|
27
|
+
|
|
28
|
+
This project uses the owflow plugin for structured development workflows. When any `/*` command is invoked, execute it via the Skill tool immediately — do not skip workflows for "straightforward" tasks. The user chose the workflow intentionally; complexity assessment is the workflow's job.
|
|
29
|
+
```
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# INDEX.md Template
|
|
2
|
+
|
|
3
|
+
Use this structure when generating or updating `.owflow/docs/INDEX.md`. Scan the actual `.owflow/docs/` directory to populate sections dynamically — do not hardcode file lists.
|
|
4
|
+
|
|
5
|
+
For technical standards, the description MUST enumerate specific practices/conventions documented in the file, not just a generic category description.
|
|
6
|
+
|
|
7
|
+
```markdown
|
|
8
|
+
# Documentation Index
|
|
9
|
+
|
|
10
|
+
**IMPORTANT**: Read this file at the beginning of any development task to understand available documentation and standards.
|
|
11
|
+
|
|
12
|
+
## Quick Reference
|
|
13
|
+
|
|
14
|
+
### Project Documentation
|
|
15
|
+
|
|
16
|
+
Project-level documentation covering vision, goals, architecture, and technology choices.
|
|
17
|
+
|
|
18
|
+
### Technical Standards
|
|
19
|
+
|
|
20
|
+
Coding standards, conventions, and best practices organized by domain.
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## Project Documentation
|
|
25
|
+
|
|
26
|
+
Located in `.owflow/docs/project/`
|
|
27
|
+
|
|
28
|
+
### Vision (`project/vision.md`)
|
|
29
|
+
|
|
30
|
+
[Brief description of what this file contains]
|
|
31
|
+
|
|
32
|
+
### Roadmap (`project/roadmap.md`)
|
|
33
|
+
|
|
34
|
+
[Brief description of what this file contains]
|
|
35
|
+
|
|
36
|
+
### Tech Stack (`project/tech-stack.md`)
|
|
37
|
+
|
|
38
|
+
[Brief description of what this file contains]
|
|
39
|
+
|
|
40
|
+
### Architecture (`project/architecture.md`)
|
|
41
|
+
|
|
42
|
+
[Brief description of what this file contains - if exists]
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## Technical Standards
|
|
47
|
+
|
|
48
|
+
### [Category Name] Standards
|
|
49
|
+
|
|
50
|
+
Located in `.owflow/docs/standards/[category]/`
|
|
51
|
+
|
|
52
|
+
#### [Standard Name] (`standards/[category]/[name].md`)
|
|
53
|
+
|
|
54
|
+
[Practice-specific description — enumerate actual conventions, not generic text]
|
|
55
|
+
|
|
56
|
+
[... repeat for all categories and standards discovered in the directory ...]
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
|
|
60
|
+
## How to Use This Documentation
|
|
61
|
+
|
|
62
|
+
1. **Start Here**: Always read this INDEX.md first to understand what documentation exists
|
|
63
|
+
2. **Project Context**: Read relevant project documentation before starting work
|
|
64
|
+
3. **Standards**: Reference appropriate standards when writing code
|
|
65
|
+
4. **Keep Updated**: Update documentation when making significant changes
|
|
66
|
+
5. **Customize**: Adapt all documentation to your project's specific needs
|
|
67
|
+
|
|
68
|
+
## Updating Documentation
|
|
69
|
+
|
|
70
|
+
- Project documentation should be updated when goals, tech stack, or architecture changes
|
|
71
|
+
- Technical standards should be updated when team conventions evolve
|
|
72
|
+
- Always update INDEX.md when adding, removing, or significantly changing documentation
|
|
73
|
+
```
|
|
@@ -0,0 +1,198 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: flow-init
|
|
3
|
+
description: Initialize AI SDLC framework with intelligent project analysis and documentation generation
|
|
4
|
+
argument-hint: [--standards-from=PATH]
|
|
5
|
+
user-invocable: true
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Initialize AI SDLC Framework
|
|
9
|
+
|
|
10
|
+
Initialize `.owflow/docs/` with intelligent project analysis and meaningful documentation generation based on actual codebase inspection.
|
|
11
|
+
|
|
12
|
+
**NOTE**: This skill invokes other skills and subagents at specific phases. Use the **Task tool with `docs-operator` subagent** (subagent_type: `docs-operator`) for all docs-manager operations, and **Task tool** for project-analyzer. Use the **Skill tool** only for standards-discover (Phase 8, last phase). The Task tool returns control to this skill after completion; the Skill tool does not.
|
|
13
|
+
|
|
14
|
+
## Phase Configuration
|
|
15
|
+
|
|
16
|
+
| Phase | Subject | activeForm |
|
|
17
|
+
| ----- | ---------------------------------- | -------------------------------- |
|
|
18
|
+
| 1 | Pre-flight checks | Running pre-flight checks |
|
|
19
|
+
| 2 | Analyze project codebase | Analyzing project codebase |
|
|
20
|
+
| 3 | Present findings & gather context | Gathering project context |
|
|
21
|
+
| 4 | Select standards to initialize | Selecting standards |
|
|
22
|
+
| 5 | Initialize documentation structure | Initializing documentation |
|
|
23
|
+
| 6 | Generate project documentation | Generating project documentation |
|
|
24
|
+
| 7 | Validate | Validating initialization |
|
|
25
|
+
| 8 | Discover coding standards | Discovering coding standards |
|
|
26
|
+
|
|
27
|
+
**Task Tracking**: Before Phase 1, use `TaskCreate` for all phases (pending), then set sequential dependencies with `TaskUpdate addBlockedBy`. At each phase: `TaskUpdate` to `in_progress` → execute → `TaskUpdate` to `completed`. If skipped (e.g., user selects "Update existing"), mark skipped phases as `completed` with `metadata: {skipped: true}`.
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## PHASE 1: Pre-flight Checks
|
|
32
|
+
|
|
33
|
+
**If `--standards-from=PATH` is provided:**
|
|
34
|
+
|
|
35
|
+
1. Resolve the path (absolute or relative to current working directory)
|
|
36
|
+
2. Check if `PATH/.owflow/docs/standards/` exists. If not, inform the user and stop — the specified project doesn't have owflow standards initialized.
|
|
37
|
+
3. Store the resolved standards source path for use in Phases 4 and 5.
|
|
38
|
+
|
|
39
|
+
Check if `.owflow/` directory already exists.
|
|
40
|
+
|
|
41
|
+
**If exists**, use question:
|
|
42
|
+
|
|
43
|
+
- Options: "Backup and reinitialize", "Update existing documentation", "Cancel"
|
|
44
|
+
- If "Backup": Create `.owflow.backup-$(date +%Y%m%d-%H%M%S)/` using Bash tool
|
|
45
|
+
- If "Update": Skip to PHASE 6 (documentation generation only)
|
|
46
|
+
- If "Cancel": Stop execution
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## PHASE 2: Project Analysis
|
|
51
|
+
|
|
52
|
+
Invoke `project-analyzer` subagent via the Task tool.
|
|
53
|
+
|
|
54
|
+
Wait for completion. Store analysis results for use in Phases 3 and 6.
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## PHASE 3: Present Findings & Gather Context
|
|
59
|
+
|
|
60
|
+
**Step 1**: Present analysis results to the user (project type, primary language/framework, architecture, tech stack, conventions, strengths/opportunities).
|
|
61
|
+
|
|
62
|
+
**Step 2**: Use question to confirm analysis accuracy. If corrections needed, collect them.
|
|
63
|
+
|
|
64
|
+
**Step 3**: Gather additional context via question (adapt to project type):
|
|
65
|
+
|
|
66
|
+
1. Project name (if not obvious)
|
|
67
|
+
2. Project description (1-2 sentences)
|
|
68
|
+
3. Primary goals (adapt question to new/existing/legacy project)
|
|
69
|
+
4. Team context (optional)
|
|
70
|
+
5. Special requirements (optional)
|
|
71
|
+
|
|
72
|
+
**Step 4**: Ask which project documentation to generate using question (multi-select):
|
|
73
|
+
|
|
74
|
+
- "Vision" — Project vision, goals, and purpose
|
|
75
|
+
- "Roadmap" — Development roadmap and planned features
|
|
76
|
+
- "Tech Stack" — Technology choices and rationale (ALWAYS selected, required)
|
|
77
|
+
- "Architecture" — System architecture and design patterns (optional)
|
|
78
|
+
|
|
79
|
+
Smart defaults based on `projectArchitectureType`:
|
|
80
|
+
|
|
81
|
+
- Standard/Frontend-only/Backend-only: All selected
|
|
82
|
+
- Monorepo/Umbrella: Only "Tech Stack" selected
|
|
83
|
+
|
|
84
|
+
Store selections for Phase 6.
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
## PHASE 4: Select Standards to Initialize
|
|
89
|
+
|
|
90
|
+
Before presenting options, explain to the user:
|
|
91
|
+
|
|
92
|
+
- **What standards are**: Coding standards are documented conventions and best practices (naming, error handling, testing patterns, etc.) that guide consistent development across the project.
|
|
93
|
+
- **Starting point**: If `--standards-from` was provided, standards come from the referenced project. Otherwise, the plugin includes generic built-in standards. Either way, they serve as a starting point and can be fully customized or extended later.
|
|
94
|
+
|
|
95
|
+
**Determine available categories:**
|
|
96
|
+
|
|
97
|
+
- **If `--standards-from` was provided**: Scan `PATH/.owflow/docs/standards/*/` to discover all available categories from the external project (may include custom categories beyond the baseline global/frontend/backend/testing).
|
|
98
|
+
- **Otherwise**: Use built-in baseline categories (global, frontend, backend, testing).
|
|
99
|
+
|
|
100
|
+
Calculate smart defaults based on analysis:
|
|
101
|
+
|
|
102
|
+
- **Global**: Always recommended (if available)
|
|
103
|
+
- **Frontend**: If frontend framework detected or projectArchitectureType includes frontend (if available)
|
|
104
|
+
- **Backend**: If backend framework detected or projectArchitectureType includes backend (if available)
|
|
105
|
+
- **Testing**: Always recommended (if available)
|
|
106
|
+
|
|
107
|
+
Also scan `.owflow/docs/standards/*/` for any existing custom categories to include.
|
|
108
|
+
|
|
109
|
+
Show smart defaults summary (noting the source: external project or built-in), then use question:
|
|
110
|
+
|
|
111
|
+
- "Use smart defaults" → proceed with calculated defaults
|
|
112
|
+
- "Customize selection" → show multi-select with all discovered categories + "Add custom category" option
|
|
113
|
+
|
|
114
|
+
Custom categories: if user adds a new category, create the directory and include it in the selection.
|
|
115
|
+
|
|
116
|
+
Store selection for Phase 5.
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
## PHASE 5: Initialize Documentation Structure
|
|
121
|
+
|
|
122
|
+
**Invoke `docs-operator` subagent** via Task tool (subagent_type: `docs-operator`) with prompt:
|
|
123
|
+
|
|
124
|
+
> "Initialize documentation structure. Standards selection: [array from Phase 4]. [If --standards-from was provided: Standards source path: [resolved path]/.owflow/docs/standards/. Copy standards from this external path instead of built-in defaults.] Only copy selected standard categories. Do NOT copy project templates — only create the project/ directory. Project documentation will be generated in Phase 6 with real content from project analysis. Create placeholder sections in INDEX.md for skipped categories."
|
|
125
|
+
|
|
126
|
+
Wait for docs-operator to complete, then immediately proceed to Phase 6.
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
## PHASE 6: Generate Project Documentation
|
|
131
|
+
|
|
132
|
+
**IMPORTANT**: Only generate docs selected in Phase 3.
|
|
133
|
+
|
|
134
|
+
For each selected doc type, read the corresponding reference template:
|
|
135
|
+
|
|
136
|
+
- Vision selected → Read `references/vision-templates.md`, select template by project type (new/existing/legacy)
|
|
137
|
+
- Roadmap selected → Read `references/roadmap-templates.md`, select template by project type
|
|
138
|
+
- Tech Stack (always) → Read `references/tech-stack-template.md`
|
|
139
|
+
- Architecture selected → Read `references/architecture-template.md`
|
|
140
|
+
|
|
141
|
+
Fill templates using:
|
|
142
|
+
|
|
143
|
+
- Analysis report data (tech stack, age, structure)
|
|
144
|
+
- User-provided context from Phase 3 (goals, users, requirements)
|
|
145
|
+
- Auto-detected project characteristics
|
|
146
|
+
|
|
147
|
+
Write each file to `.owflow/docs/project/`.
|
|
148
|
+
|
|
149
|
+
---
|
|
150
|
+
|
|
151
|
+
## PHASE 7: Validate
|
|
152
|
+
|
|
153
|
+
**Step 1**: Invoke `docs-operator` subagent via Task tool (subagent_type: `docs-operator`) with prompt:
|
|
154
|
+
|
|
155
|
+
> "Regenerate INDEX.md to include all newly created project documentation. Then verify AGENTS.md is properly integrated with .owflow/docs/ documentation."
|
|
156
|
+
|
|
157
|
+
Wait for docs-operator to complete, then immediately continue with Step 2.
|
|
158
|
+
|
|
159
|
+
**Step 2**: Run validation checks:
|
|
160
|
+
|
|
161
|
+
- Verify INDEX.md exists
|
|
162
|
+
- Verify tech-stack.md exists (required)
|
|
163
|
+
- Verify selected docs exist
|
|
164
|
+
- Verify selected standards directories exist
|
|
165
|
+
- Verify AGENTS.md integration
|
|
166
|
+
|
|
167
|
+
**Step 3**: Display comprehensive summary:
|
|
168
|
+
|
|
169
|
+
- Project analysis results (type, language, framework, architecture)
|
|
170
|
+
- Structure created (tree with check marks for created items)
|
|
171
|
+
- Documentation status (which docs generated, which standards initialized)
|
|
172
|
+
- Key findings (strengths, opportunities)
|
|
173
|
+
- Next steps:
|
|
174
|
+
1. Review generated documentation
|
|
175
|
+
2. Customize for your team
|
|
176
|
+
3. Start development with `/work`
|
|
177
|
+
4. Keep documentation current
|
|
178
|
+
|
|
179
|
+
---
|
|
180
|
+
|
|
181
|
+
## PHASE 8: Discover Coding Standards
|
|
182
|
+
|
|
183
|
+
Invoke the `standards-discover` skill via Skill tool with `--scope=full` to automatically discover coding standards from the project's config files, source code patterns, documentation, and external sources.
|
|
184
|
+
|
|
185
|
+
> "Run standards discovery with --scope=full. This is being invoked as part of project initialization."
|
|
186
|
+
|
|
187
|
+
The standards-discover skill handles its own user interaction (presenting findings by confidence tier, asking for approval). Let it run its full workflow — this is the last phase of init, so context handoff is fine here.
|
|
188
|
+
|
|
189
|
+
After completion, display a brief summary of how many standards were discovered and applied.
|
|
190
|
+
|
|
191
|
+
---
|
|
192
|
+
|
|
193
|
+
## Error Handling Principles
|
|
194
|
+
|
|
195
|
+
- If `.owflow/docs/` creation fails: check permissions, suggest manual creation
|
|
196
|
+
- If project-analyzer fails: offer to proceed with manual input only
|
|
197
|
+
- If docs-manager fails: offer retry (max 2 attempts), then manual instructions
|
|
198
|
+
- Never auto-rollback — always ask user before destructive actions
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Architecture Document Template
|
|
2
|
+
|
|
3
|
+
Optional documentation — only generate if user selected "Architecture" in Phase 3.
|
|
4
|
+
|
|
5
|
+
```markdown
|
|
6
|
+
# System Architecture
|
|
7
|
+
|
|
8
|
+
## Overview
|
|
9
|
+
[High-level description of system architecture]
|
|
10
|
+
|
|
11
|
+
## Architecture Pattern
|
|
12
|
+
**Pattern**: [From analysis - e.g., "Layered monolithic with REST API"]
|
|
13
|
+
|
|
14
|
+
[Description of how the pattern is implemented]
|
|
15
|
+
|
|
16
|
+
## System Structure
|
|
17
|
+
|
|
18
|
+
### [Component 1]
|
|
19
|
+
- **Location**: [From analysis - e.g., "src/api/"]
|
|
20
|
+
- **Purpose**: [What it does]
|
|
21
|
+
- **Key Files**: [List from analysis]
|
|
22
|
+
|
|
23
|
+
### [Component 2]
|
|
24
|
+
- **Location**: [From analysis]
|
|
25
|
+
- **Purpose**: [What it does]
|
|
26
|
+
- **Key Files**: [List from analysis]
|
|
27
|
+
|
|
28
|
+
## Data Flow
|
|
29
|
+
[Describe how data flows through the system]
|
|
30
|
+
|
|
31
|
+
## External Integrations
|
|
32
|
+
[List integrations found in analysis - databases, APIs, services]
|
|
33
|
+
|
|
34
|
+
## Database Schema
|
|
35
|
+
[If ORM detected, reference schema file location]
|
|
36
|
+
|
|
37
|
+
## Configuration
|
|
38
|
+
[How configuration is managed]
|
|
39
|
+
|
|
40
|
+
## Deployment Architecture
|
|
41
|
+
[If detected - Docker, K8s, cloud services]
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
*Based on codebase analysis performed [Date]*
|
|
45
|
+
```
|