codex-genesis-harness 0.1.1 → 0.1.4

package/.codex/skills/genesis-docs-automation/templates/handoff-template.md

@@ -0,0 +1,297 @@
+# Template: Implementation Handoff Document
+
+**Copy this template when handing off work from one phase to the next**
+
+---
+
+# Handoff: [Feature Name] → Phase [X] ([Next Phase Name])
+
+**Status**: ✅ Ready for handoff / ⏳ In progress / ❌ Blocked
+**From**: Phase [X] ([Current Phase]) | **To**: Phase [X+1] ([Next Phase])
+**Date**: YYYY-MM-DD
+**Owner**: [Your name] | **Contact**: [email/slack]
+
+---
+
+## ✅ What's Completed (Phase [X])
+
+### Phase [X-1]: [Name] ✅ (if applicable)
+- [x] [Deliverable 1]
+- [x] [Deliverable 2]
+- [x] [Deliverable 3]
+
+### Phase [X]: [Current Phase Name] ✅
+- [x] [Major work item 1]
+- [x] [Major work item 2]
+- [x] [Major work item 3]
+- [x] [Major work item 4]
+- [x] [Major work item 5]
+
+**Key Achievements**:
+- [Achievement 1 with metric]
+- [Achievement 2 with metric]
+- [Achievement 3 with metric]
+
+**Test Results**: ✅ ALL PASSING
+- Tests run: [N]
+- Coverage: [%]
+- Failures: 0
+
+---
+
+## ⏳ What Needs Phase [X+1]
+
+### Immediate Tasks (High Priority)
+
+1. **[Task 1]** (Est. [time])
+   - [Sub-task 1.1]
+   - [Sub-task 1.2]
+   - [Sub-task 1.3]
+   - **Blocking**: [Is this blocking other work? YES/NO]
+
+2. **[Task 2]** (Est. [time])
+   - [Sub-task 2.1]
+   - [Sub-task 2.2]
+   - [Sub-task 2.3]
+
+3. **[Task 3]** (Est. [time])
+   - [Sub-task 3.1]
+   - [Sub-task 3.2]
+
+### Optional/Future Tasks (Nice to Have)
+
+1. **[Enhancement 1]** - Recommended in v2.X
+2. **[Enhancement 2]** - Can wait until v2.X+1
+
+---
+
+## 🔑 Key Behaviors to Know
+
+### Scenario 1: [Common/Happy Path]
+
+**Input**: [What user provides]
+**Process**: [What happens internally]
+**Output**: [What user gets]
+**Example**:
+```
+Input: { email: "user@example.com", ... }
+→ Validation checks
+→ Database insert
+→ Response: { id: "uuid", email, ... }
+```
+
+### Scenario 2: [Error Case 1]
+
+**Condition**: [When this happens]
+**Response**: [Status code + error message]
+**Example**:
+```json
+Status: 409
+Response: { error: "Email already registered" }
+```
+
+### Scenario 3: [Error Case 2]
+
+**Condition**: [When this happens]
+**Response**: [Status code + error message]
+**Example**:
+```json
+Status: 422
+Response: { error: "Password too weak" }
+```
+
+---
+
+## 📊 Type Definitions
+
+**Primary Type**:
+```typescript
+interface [TypeName] {
+  [field1]: [type];    // Description
+  [field2]?: [type];   // Optional description
+  [field3]: [type];    // Description
+}
+```
+
+**Error Types**:
+```typescript
+class [ErrorName] extends Error { 
+  code: [status-code]; 
+  message: [description]; 
+}
+```
+
+**Example Usage**:
+```typescript
+try {
+  const result: [TypeName] = await [method]([params]);
+  // Use result
+} catch (error) {
+  if (error instanceof [ErrorName]) {
+    // Handle specific error
+  }
+}
+```
+
+---
+
+## 🎯 Design Decisions & Rationale
+
+### Decision 1: [What was decided]
+- **Choice**: [Option chosen]
+- **Why**: [Reason for choice]
+- **Alternatives**: [Other options considered and why they weren't chosen]
+- **Trade-offs**: [What we give up with this choice]
+- **Test**: [How we verified this was right choice]
+
+### Decision 2: [What was decided]
+- **Choice**: [Option chosen]
+- **Why**: [Reason for choice]
+- **Implications**: [Long-term impact of this decision]
+
+---
+
+## ⚠️ Known Issues & Limitations
+
+### 🟡 Medium Priority Issues
+
+1. **[Issue Name]**: [Description]
+   - **Severity**: Medium
+   - **Workaround**: [Temporary workaround if available]
+   - **Timeline**: [When will this be fixed?]
+   - **Impact**: [What does this affect?]
+
+2. **[Issue Name]**: [Description]
+   - **Severity**: Medium
+   - **Cause**: [Root cause]
+   - **Fix Timeline**: [When is it expected to be fixed?]
+
+### 🟢 Low Priority Issues
+
+1. **[Issue Name]**: [Description]
+   - **Workaround**: [Available]
+   - **Can wait until**: v2.X
+
+### ⚫ Resolved During Phase [X]
+
+1. ✅ [Issue that was found and fixed]
+2. ✅ [Issue that was found and fixed]
+
+---
+
+## 📋 Phase [X+1] Testing Checklist
+
+**Before marking Phase [X+1] complete, verify**:
+
+- [ ] [Test 1]: [What should be tested and expected result]
+- [ ] [Test 2]: [What should be tested and expected result]
+- [ ] [Test 3]: [What should be tested and expected result]
+- [ ] [Test 4]: [What should be tested and expected result]
+- [ ] [Test 5]: [What should be tested and expected result]
+- [ ] All unit tests passing
+- [ ] All integration tests passing
+- [ ] Performance acceptable ([metric])
+- [ ] No console errors or warnings
+- [ ] Documentation complete
+
+---
+
+## 🎓 Documentation References
+
+**For Phase [X+1] team**:
+- [API Reference](API_REFERENCE.md#section): Endpoint specifications
+- [Implementation Guide](IMPLEMENTATION.md#section): Internal implementation details
+- [Architecture Docs](ARCHITECTURE.md#section): System design and data flow
+- [Testing Guide](TESTING.md#section): How to write tests for this feature
+
+---
+
+## 💻 Code References
+
+**Key Files**:
+- `[file1.ts](path/to/file1.ts)`: [What this file does]
+- `[file2.ts](path/to/file2.ts)`: [What this file does]
+- `[file3.ts](path/to/file3.ts)`: [What this file does]
+
+**Key Functions**:
+- `[functionName()](path#L12)`: [What it does]
+- `[functionName()](path#L34)`: [What it does]
+
+---
+
+## 🚀 Next Phase (Phase [X+1])
+
+**First Steps**:
+1. [First task to do]
+2. [Second task to do]
+3. [Third task to do]
+
+**Dependencies**:
+- [ ] Phase [X] 100% complete (you're reading this, so YES)
+- [ ] [Other dependency]
+- [ ] [Other dependency]
+
+**Success Criteria**:
+- [ ] [Criteria 1 - what must be true to call it done?]
+- [ ] [Criteria 2 - what must be true to call it done?]
+- [ ] [Criteria 3 - what must be true to call it done?]
+
+---
+
+## 📞 Questions & Support
+
+### For Phase [X] Questions
+- **Technical Lead**: [Name] ([email](mailto:email) | [slack](#slack))
+- **Architecture**: [Name] ([email](mailto:email))
+- **Database/Schema**: [Name] ([email](mailto:email))
+
+### For Phase [X+1] Questions
+- Feel free to reach out to Phase [X] team during onboarding
+- Suggest: Weekly sync for first 2 weeks of Phase [X+1]
+
+---
+
+## ✅ Sign-Off Checklist
+
+**Phase [X] Lead**:
+- [ ] All deliverables complete
+- [ ] Tests passing (100%)
+- [ ] Code reviewed
+- [ ] Documentation complete
+- [ ] Known issues documented
+- [ ] Ready to hand off
+
+**Sign-Off**: 
+- **Name**: _________________________
+- **Date**: _________________________
+- **Approval**: ✅ APPROVED
+
+**Alternate Sign-Off** (if Phase [X] lead unavailable):
+- **Name**: _________________________
+- **Title**: _________________________
+- **Date**: _________________________
+- **Approval**: ✅ APPROVED
+
+---
+
+## 📝 Metadata
+
+- **Document Version**: v1.0
+- **Phase [X] Duration**: [Start date] → [End date] ([N] days)
+- **Person-hours**: [N hours]
+- **Files Modified**: [N]
+- **Tests Added**: [N]
+- **Documentation Files**: [N]
+- **External Dependencies Added**: [N or none]
+- **Database Migrations**: [N or none]
+- **Configuration Changes**: [N or none]
+
+---
+
+**How to Use This Template**:
+1. Copy this entire document
+2. Replace all [bracketed sections] with actual content
+3. Delete sections that don't apply
+4. Keep sections you do use
+5. Share with next phase team
+6. Store in project docs for reference