Initial commit

skills/spec-author/templates/flow-schematic.md

@@ -0,0 +1,146 @@
+# Flow Schematic: <!-- TODO: Feature Name -->
+
+**Document ID:** `flow-[project]-[feature-id]-[description]`
+**Status:** <!-- TODO: Draft | In Review | Approved -->
+**Last Updated:** <!-- TODO: YYYY-MM-DD -->
+**Owner:** <!-- TODO: Team/Individual -->
+**Related Specs:** <!-- TODO: List related spec IDs -->
+
+---
+
+## Overview
+
+<!-- TODO: Brief description of what this flow accomplishes and why it exists -->
+
+**Purpose:** <!-- TODO: 1-2 sentences on the business/technical goal -->
+
+**Trigger:** <!-- TODO: What initiates this flow - user action, system event, scheduled task, etc. -->
+
+**Outcome:** <!-- TODO: Expected end state when flow completes successfully -->
+
+---
+
+## Scope & Context
+
+### In Scope
+<!-- TODO: List what's in scope:
+- Primary flow path
+- Key decision points
+- Critical error handling
+-->
+
+### Out of Scope
+<!-- TODO: List what's out of scope:
+- Edge cases handled elsewhere
+- Related but separate flows
+-->
+
+### Assumptions
+<!-- TODO: List assumptions:
+- Required preconditions
+- System state assumptions
+-->
+
+---
+
+## Flow Steps
+
+<!-- TODO: Main flow sequence - focus on the happy path. Document in table format:
+| Step | Actor | Action | Decision/Output |
+|------|-------|--------|-----------------|
+| 1 | [System/User/Service] | [Action description] | [Decision criteria or next step] |
+| 2 | [System/User/Service] | [Action description] | [Decision criteria or next step] |
+-->
+
+---
+
+## Decision Points
+
+<!-- TODO: Key decisions that affect flow direction
+
+### Decision 1: [Name]
+**Condition:** [What triggers this decision]
+**Options:**
+- **Path A:** [Condition] → [Outcome]
+- **Path B:** [Condition] → [Outcome]
+-->
+
+---
+
+## Error Handling
+
+<!-- TODO: Critical error scenarios and recovery strategies. Document in table format:
+| Error Type | Detection | Recovery Action | Fallback |
+|------------|-----------|-----------------|----------|
+| [Error category] | [How identified] | [Primary recovery] | [If recovery fails] |
+-->
+
+**Rollback Strategy:** <!-- TODO: How to undo partial completion -->
+
+---
+
+## Dependencies
+
+### System Dependencies
+<!-- TODO: List required services, data sources, and infrastructure:
+- **Services:** [Required services/APIs]
+- **Data:** [Required data sources]
+- **Infrastructure:** [Required infrastructure components]
+-->
+
+### External Dependencies
+<!-- TODO: OPTIONAL - Remove if not applicable. List external services and user actions:
+- **Third-party APIs:** [External services]
+- **User Actions:** [Required user inputs]
+-->
+
+### Upstream Flows
+<!-- TODO: OPTIONAL - Remove if not applicable. List flows that must complete before this one -->
+
+### Downstream Flows
+<!-- TODO: OPTIONAL - Remove if not applicable. List flows triggered by this one -->
+
+---
+
+## Success Criteria
+
+<!-- TODO: How to verify the flow completed correctly -->
+
+### Functional Success
+<!-- TODO: List functional criteria:
+- [ ] [Key outcome 1 achieved]
+- [ ] [Key outcome 2 achieved]
+- [ ] [Data consistency verified]
+-->
+
+### Technical Success
+<!-- TODO: List technical criteria:
+- [ ] [No errors logged]
+- [ ] [State correctly updated]
+- [ ] [Downstream systems notified]
+-->
+
+---
+
+## Performance Targets
+
+<!-- TODO: Document performance targets in table format:
+| Metric | Target | Measurement Point |
+|--------|--------|-------------------|
+| End-to-end latency | [e.g., <500ms] | [Start to completion] |
+| Individual step time | [e.g., <100ms] | [Critical step] |
+| Throughput | [e.g., 1000 req/sec] | [Peak load scenario] |
+| Error rate | [e.g., <0.1%] | [Per 1000 executions] |
+-->
+
+**Timeout:** <!-- TODO: Maximum flow duration before abort -->
+
+---
+
+## Notes
+
+<!-- TODO: OPTIONAL - Remove if not applicable. Additional context, caveats, or future considerations:
+- [Important consideration 1]
+- [Important consideration 2]
+- [Known limitation or future enhancement]
+-->