Patrick Plate
137 lines
3.0 KiB
Markdown
137 lines
3.0 KiB
Markdown
---
|
|
name: generate-handover
|
|
description: Generate handover document for session or person transfer.
|
|
---
|
|
|
|
# Skill: generate-handover
|
|
|
|
Generate handover document for session or person transfer.
|
|
|
|
## Invoked by
|
|
|
|
📝 DocGen mode (or 🪃 Orchestrator)
|
|
|
|
## Required Inputs
|
|
|
|
| Input | Source | Example |
|
|
|-------|--------|---------|
|
|
| `TICKET_KEY` | Jira issue key | `PROJECT-123` |
|
|
| `MODULE` | Module/component name | `auth`, `api`, `core` |
|
|
| `SESSION_ID` | BigMind session to hand over (optional) | `d8a0f4fa-...` |
|
|
|
|
## Output
|
|
|
|
Markdown file: `docs/<MODULE>/<TICKET_KEY>/<TICKET_KEY>-handover-<date>.md`
|
|
|
|
## Steps
|
|
|
|
### 1. Read BigMind session context
|
|
|
|
```python
|
|
memory_get_session_detail(session_id=SESSION_ID)
|
|
memory_search_facts("<TICKET_KEY>")
|
|
memory_search_chunks("<TICKET_KEY>")
|
|
```
|
|
|
|
### 2. Read git status
|
|
|
|
```bash
|
|
cd <worktree-path>
|
|
git branch --show-current
|
|
git status
|
|
git log origin/main..HEAD --oneline
|
|
git diff origin/main --stat
|
|
```
|
|
|
|
### 3. Read Jira ticket status
|
|
|
|
```python
|
|
ticket = retrieve_ticket_details(TICKET_KEY)
|
|
checklist = get_checklist(TICKET_KEY)
|
|
```
|
|
|
|
### 4. Read existing documentation
|
|
|
|
Check `docs/<MODULE>/<TICKET_KEY>/` for assessment, plan, testplan, solution, review docs.
|
|
|
|
### 5. Analyze what's done vs. remaining
|
|
|
|
Cross-reference Jira checklist, git commits, test plan status, and plan steps.
|
|
|
|
### 6. Generate handover document
|
|
|
|
```markdown
|
|
# Handover: <TICKET_KEY> — <Summary>
|
|
|
|
**Date:** <today>
|
|
**Module:** <MODULE>
|
|
**Author:** Lumen (DocGen)
|
|
**BigMind Session:** `<SESSION_ID>`
|
|
**Branch:** <current branch>
|
|
|
|
---
|
|
|
|
## 1. Current State
|
|
|
|
**Jira Status:** <status>
|
|
**Progress:** <X>/<Y> checklist items complete
|
|
|
|
<1-3 sentence summary>
|
|
|
|
## 2. Completed Work
|
|
|
|
| # | Description | Files | Commit |
|
|
|---|------------|-------|--------|
|
|
| 1 | <what was done> | `<file1>`, `<file2>` | `<hash>` |
|
|
|
|
## 3. Remaining Work
|
|
|
|
| # | Description | Priority | Estimated Effort |
|
|
|---|------------|----------|-----------------|
|
|
| 1 | <what remains> | High/Medium/Low | <estimate> |
|
|
|
|
## 4. Open Questions / Blockers
|
|
|
|
| # | Question/Blocker | Context | Contact |
|
|
|---|-----------------|---------|---------|
|
|
| 1 | <question> | <context> | <who> |
|
|
|
|
## 5. Key Decisions
|
|
|
|
| Decision | Rationale | Date |
|
|
|----------|----------|------|
|
|
| <decision> | <why> | <date> |
|
|
|
|
## 6. Technical Notes
|
|
|
|
- <Important context the next person needs>
|
|
- <Environment setup needed>
|
|
- <Test data requirements>
|
|
|
|
## 7. Context Recovery
|
|
|
|
For continuing this work:
|
|
- **Worktree:** `<path>`
|
|
- **Branch:** `<branch name>`
|
|
- **BigMind Session:** `<SESSION_ID>` — `memory_get_session_detail("<ID>")` for details
|
|
- **Documentation:** `docs/<MODULE>/<TICKET_KEY>/`
|
|
```
|
|
|
|
### 7. Store in BigMind
|
|
|
|
```python
|
|
memory_store_fact(
|
|
category="codebase",
|
|
fact=f"{TICKET_KEY}: Handover doc created. Status: {done}/{total} items done."
|
|
)
|
|
```
|
|
|
|
## When to Use
|
|
|
|
| Scenario | Trigger |
|
|
|----------|---------|
|
|
| End of day | Capture progress before stopping work |
|
|
| Person transfer | Handing ticket to another developer |
|
|
| Session recovery | After IDE crash, use to restore context |
|
|
| Long pause | Before vacation or multi-day break |
|