mirror of
https://github.com/rennf93/roboco.git
synced 2026-08-03 07:23:24 +02:00
Initial implementation
This commit is contained in:
Renn F
@@ -0,0 +1,114 @@
|
||||
# Task Templates
|
||||
|
||||
Templates for creating task records in the RoboCo task management system.
|
||||
|
||||
## Task Type Templates
|
||||
|
||||
These templates are used to create the main README.md for a task:
|
||||
|
||||
| Template | Use When | Key Features |
|
||||
|----------|----------|--------------|
|
||||
| [feature.md](feature.md) | Building new functionality | User story, acceptance criteria, technical details |
|
||||
| [bugfix.md](bugfix.md) | Fixing bugs | Reproduction steps, root cause, fix verification |
|
||||
| [research.md](research.md) | Investigation/research tasks | Research questions, findings, recommendations |
|
||||
| [documentation.md](documentation.md) | Writing/updating docs | Source materials, publication locations |
|
||||
| [design.md](design.md) | UX/UI design work | Figma links, states checklist, handoff |
|
||||
|
||||
## Supporting Templates
|
||||
|
||||
These templates are used for files within a task directory:
|
||||
|
||||
| Template | Purpose | Created By |
|
||||
|----------|---------|------------|
|
||||
| [plan.md](plan.md) | Implementation plan | Developer during planning |
|
||||
| [journal.md](journal.md) | Agent journey notes | Developer during execution |
|
||||
| [decisions.md](decisions.md) | Decision log | Anyone making decisions |
|
||||
| [blockers.md](blockers.md) | Blocker tracking | Anyone when blocked |
|
||||
| [handoff.md](handoff.md) | Documenter handoff | Developer when complete |
|
||||
| [qa-review.md](qa-review.md) | QA findings | QA during review |
|
||||
|
||||
## Initiative Templates
|
||||
|
||||
In `../initiatives/_template/`:
|
||||
|
||||
| Template | Purpose |
|
||||
|----------|---------|
|
||||
| README.md | Initiative overview |
|
||||
| requirements.md | Detailed requirements |
|
||||
| tasks.md | Task breakdown by cell |
|
||||
| timeline.md | Milestones and schedule |
|
||||
| decisions.md | Cross-cell decisions |
|
||||
| status.md | Status updates |
|
||||
|
||||
## Creating a New Task
|
||||
|
||||
### 1. Determine Task Type
|
||||
- New feature → `feature.md`
|
||||
- Bug fix → `bugfix.md`
|
||||
- Research/investigation → `research.md`
|
||||
- Documentation → `documentation.md`
|
||||
- Design work → `design.md`
|
||||
|
||||
### 2. Create Task Directory
|
||||
```bash
|
||||
mkdir -p .tasks/active/TASK-XXX-{slug}
|
||||
```
|
||||
|
||||
### 3. Copy Template
|
||||
```bash
|
||||
cp .tasks/templates/{type}.md .tasks/active/TASK-XXX-{slug}/README.md
|
||||
```
|
||||
|
||||
### 4. Fill In Template
|
||||
- Replace all `{placeholders}`
|
||||
- Update status section
|
||||
- Define acceptance criteria
|
||||
- Add to index.md
|
||||
|
||||
### 5. Create Supporting Files As Needed
|
||||
```bash
|
||||
# Copy templates as needed during work
|
||||
cp .tasks/templates/plan.md .tasks/active/TASK-XXX-{slug}/
|
||||
cp .tasks/templates/journal.md .tasks/active/TASK-XXX-{slug}/
|
||||
```
|
||||
|
||||
## Template Conventions
|
||||
|
||||
### Placeholders
|
||||
- `{ID}` - Task number (e.g., 042)
|
||||
- `{Title}` - Human-readable title
|
||||
- `{agent-id}` - Agent identifier (e.g., be-dev-1)
|
||||
- `YYYY-MM-DD` - ISO date format
|
||||
- `{slug}` - Kebab-case description
|
||||
|
||||
### Status Values
|
||||
- `pending` - Not started
|
||||
- `claimed` - Assigned, not started
|
||||
- `in_progress` - Active work
|
||||
- `blocked` - Waiting on something
|
||||
- `paused` - Intentionally stopped
|
||||
- `verifying` - Self-review
|
||||
- `awaiting_qa` - Ready for QA
|
||||
- `needs_revision` - QA found issues
|
||||
- `awaiting_documentation` - Ready for docs
|
||||
- `completed` - Done
|
||||
|
||||
### Priority Values
|
||||
- `P0` - Critical, drop everything
|
||||
- `P1` - High, next up
|
||||
- `P2` - Medium, normal queue
|
||||
- `P3` - Low, when available
|
||||
|
||||
### Cell Values
|
||||
- `backend` - Backend cell
|
||||
- `frontend` - Frontend cell
|
||||
- `ux_ui` - UX/UI cell
|
||||
- `board` - Board level
|
||||
|
||||
## Tips
|
||||
|
||||
1. **Always update README.md** when status changes
|
||||
2. **Journal frequently** - context is valuable
|
||||
3. **Link commits** as you make them
|
||||
4. **Create handoff.md** before marking awaiting_documentation
|
||||
5. **Be specific** in acceptance criteria - vague = wasted time
|
||||
@@ -0,0 +1,86 @@
|
||||
# Blockers: TASK-{ID}
|
||||
|
||||
> **Status**: {BLOCKED / RESOLVED}
|
||||
> **Last Updated**: YYYY-MM-DD
|
||||
|
||||
---
|
||||
|
||||
## Active Blockers
|
||||
|
||||
### Blocker 1: {Title}
|
||||
|
||||
| Field | Value |
|
||||
|-------|-------|
|
||||
| **Identified** | YYYY-MM-DD |
|
||||
| **Type** | {dependency / technical / resource / external / clarification} |
|
||||
| **Severity** | {critical / high / medium / low} |
|
||||
| **Blocking** | {what this prevents} |
|
||||
| **Owner** | {who's working on resolution} |
|
||||
| **Status** | {investigating / escalated / waiting / resolved} |
|
||||
|
||||
#### Description
|
||||
{What is the blocker? Be specific.}
|
||||
|
||||
#### Impact
|
||||
{What work is blocked? What's the downstream effect?}
|
||||
|
||||
#### Resolution Path
|
||||
1. {Step 1 to resolve}
|
||||
2. {Step 2 to resolve}
|
||||
|
||||
#### Workaround
|
||||
{Is there a temporary workaround? Or "None available"}
|
||||
|
||||
#### Escalation
|
||||
- **Escalated to**: {agent/role}
|
||||
- **Escalated on**: YYYY-MM-DD
|
||||
- **Response**: {response or "Awaiting"}
|
||||
|
||||
#### Updates
|
||||
| Date | Update |
|
||||
|------|--------|
|
||||
| YYYY-MM-DD | {Initial identification} |
|
||||
| YYYY-MM-DD | {Update} |
|
||||
|
||||
---
|
||||
|
||||
### Blocker 2: {Title}
|
||||
|
||||
{Same format as above}
|
||||
|
||||
---
|
||||
|
||||
## Resolved Blockers
|
||||
|
||||
### Blocker: {Title} [RESOLVED]
|
||||
|
||||
| Field | Value |
|
||||
|-------|-------|
|
||||
| **Identified** | YYYY-MM-DD |
|
||||
| **Resolved** | YYYY-MM-DD |
|
||||
| **Duration** | X days |
|
||||
| **Type** | {type} |
|
||||
|
||||
#### What Happened
|
||||
{Brief description of the blocker}
|
||||
|
||||
#### How It Was Resolved
|
||||
{How was it unblocked?}
|
||||
|
||||
#### Lessons Learned
|
||||
{What could prevent this in the future?}
|
||||
|
||||
---
|
||||
|
||||
## Blocker Summary
|
||||
|
||||
| # | Title | Type | Severity | Identified | Resolved | Duration |
|
||||
|---|-------|------|----------|------------|----------|----------|
|
||||
| 1 | {title} | {type} | {severity} | YYYY-MM-DD | - | ongoing |
|
||||
| 2 | {title} | {type} | {severity} | YYYY-MM-DD | YYYY-MM-DD | X days |
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
|
||||
{Additional context about blockers}
|
||||
@@ -0,0 +1,150 @@
|
||||
# TASK-{ID}: {Title}
|
||||
|
||||
> **Template**: Bugfix
|
||||
> **Created**: YYYY-MM-DD
|
||||
> **Last Updated**: YYYY-MM-DD
|
||||
|
||||
---
|
||||
|
||||
## Status
|
||||
|
||||
| Field | Value |
|
||||
|-------|-------|
|
||||
| **State** | `pending` |
|
||||
| **Priority** | P{0-3} |
|
||||
| **Severity** | {critical / high / medium / low} |
|
||||
| **Cell** | {backend / frontend / ux_ui} |
|
||||
| **Assigned To** | {agent-id or "unassigned"} |
|
||||
| **Reported By** | {agent-id / user / automated} |
|
||||
|
||||
## Timeline
|
||||
|
||||
| Milestone | Date |
|
||||
|-----------|------|
|
||||
| Reported | YYYY-MM-DD |
|
||||
| Claimed | - |
|
||||
| Root Cause Found | - |
|
||||
| Fix Implemented | - |
|
||||
| QA Verified | - |
|
||||
| Completed | - |
|
||||
|
||||
---
|
||||
|
||||
## Bug Summary
|
||||
|
||||
{One sentence description of the bug}
|
||||
|
||||
## Severity Assessment
|
||||
|
||||
| Factor | Assessment |
|
||||
|--------|------------|
|
||||
| **User Impact** | {How many users affected? How badly?} |
|
||||
| **Frequency** | {How often does it occur?} |
|
||||
| **Workaround** | {Is there a workaround? What is it?} |
|
||||
| **Data Impact** | {Any data loss or corruption?} |
|
||||
|
||||
---
|
||||
|
||||
## Reproduction
|
||||
|
||||
### Environment
|
||||
- **Browser/Client**: {e.g., Chrome 120, iOS app v2.1}
|
||||
- **OS**: {e.g., macOS 14.1, Windows 11}
|
||||
- **User Type**: {e.g., admin, regular user}
|
||||
- **Environment**: {production / staging / development}
|
||||
|
||||
### Steps to Reproduce
|
||||
1. {Step 1}
|
||||
2. {Step 2}
|
||||
3. {Step 3}
|
||||
4. {Observe the bug}
|
||||
|
||||
### Expected Behavior
|
||||
{What should happen}
|
||||
|
||||
### Actual Behavior
|
||||
{What actually happens}
|
||||
|
||||
### Evidence
|
||||
{Screenshots, error logs, console output}
|
||||
|
||||
```
|
||||
{Paste error messages or logs here}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Investigation
|
||||
|
||||
### Root Cause
|
||||
{Filled in during investigation - what's causing this bug?}
|
||||
|
||||
### Affected Code
|
||||
{Files and functions involved}
|
||||
- `path/to/file.py:line_number`
|
||||
- `path/to/other_file.py:line_number`
|
||||
|
||||
### Related Issues
|
||||
- {Link to related bugs or tasks}
|
||||
- {Previous similar issues}
|
||||
|
||||
---
|
||||
|
||||
## Fix
|
||||
|
||||
### Approach
|
||||
{How will this be fixed?}
|
||||
|
||||
### Changes Required
|
||||
- [ ] {Change 1}
|
||||
- [ ] {Change 2}
|
||||
- [ ] {Change 3}
|
||||
|
||||
### Regression Risk
|
||||
{What could break as a result of this fix?}
|
||||
|
||||
### Testing Plan
|
||||
- [ ] {Test case 1 - verifies fix}
|
||||
- [ ] {Test case 2 - checks regression}
|
||||
- [ ] {Test case 3 - edge cases}
|
||||
|
||||
---
|
||||
|
||||
## Verification Criteria
|
||||
|
||||
- [ ] Bug no longer reproducible with original steps
|
||||
- [ ] No new errors in logs
|
||||
- [ ] Related functionality still works
|
||||
- [ ] Tests added to prevent regression
|
||||
- [ ] {Additional verification criteria}
|
||||
|
||||
---
|
||||
|
||||
## Commits
|
||||
|
||||
| Commit | Description | Date |
|
||||
|--------|-------------|------|
|
||||
| - | No commits yet | - |
|
||||
|
||||
---
|
||||
|
||||
## Quick Context Restore
|
||||
|
||||
**Current state**: Not started
|
||||
**Investigation status**: Not started
|
||||
**Root cause**: Unknown
|
||||
**Fix approach**: TBD
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
|
||||
{Additional context, related issues, customer impact notes}
|
||||
|
||||
---
|
||||
|
||||
## Changelog
|
||||
|
||||
| Date | Agent | Change |
|
||||
|------|-------|--------|
|
||||
| YYYY-MM-DD | {agent} | Bug reported |
|
||||
@@ -0,0 +1,58 @@
|
||||
# Decisions: TASK-{ID}
|
||||
|
||||
Log of decisions made during this task.
|
||||
|
||||
---
|
||||
|
||||
## Decision 1: {Title}
|
||||
|
||||
**Date**: YYYY-MM-DD
|
||||
**Decider**: {agent-id}
|
||||
|
||||
### Context
|
||||
{What situation required a decision?}
|
||||
|
||||
### Options Considered
|
||||
|
||||
**Option A: {Name}**
|
||||
- Pros: {list}
|
||||
- Cons: {list}
|
||||
|
||||
**Option B: {Name}**
|
||||
- Pros: {list}
|
||||
- Cons: {list}
|
||||
|
||||
### Decision
|
||||
**Chose {Option X}** because {brief rationale}
|
||||
|
||||
### Consequences
|
||||
- {What this means going forward}
|
||||
- {Trade-offs accepted}
|
||||
|
||||
---
|
||||
|
||||
## Decision 2: {Title}
|
||||
|
||||
**Date**: YYYY-MM-DD
|
||||
**Decider**: {agent-id}
|
||||
|
||||
### Context
|
||||
{What situation required a decision?}
|
||||
|
||||
### Options Considered
|
||||
{...}
|
||||
|
||||
### Decision
|
||||
{...}
|
||||
|
||||
### Consequences
|
||||
{...}
|
||||
|
||||
---
|
||||
|
||||
## Quick Reference
|
||||
|
||||
| # | Decision | Date | Summary |
|
||||
|---|----------|------|---------|
|
||||
| 1 | {title} | YYYY-MM-DD | {one-line summary} |
|
||||
| 2 | {title} | YYYY-MM-DD | {one-line summary} |
|
||||
@@ -0,0 +1,199 @@
|
||||
# TASK-{ID}: {Title}
|
||||
|
||||
> **Template**: Design
|
||||
> **Created**: YYYY-MM-DD
|
||||
> **Last Updated**: YYYY-MM-DD
|
||||
|
||||
---
|
||||
|
||||
## Status
|
||||
|
||||
| Field | Value |
|
||||
|-------|-------|
|
||||
| **State** | `pending` |
|
||||
| **Priority** | P{0-3} |
|
||||
| **Cell** | ux_ui |
|
||||
| **Assigned To** | {agent-id or "unassigned"} |
|
||||
| **Requested By** | {agent-id} |
|
||||
| **For Initiative** | {initiative-id or "standalone"} |
|
||||
|
||||
## Timeline
|
||||
|
||||
| Milestone | Date |
|
||||
|-----------|------|
|
||||
| Requested | YYYY-MM-DD |
|
||||
| Started | - |
|
||||
| First Draft | - |
|
||||
| QA Review | - |
|
||||
| Revisions Complete | - |
|
||||
| Handed Off | - |
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
{What needs to be designed and why?}
|
||||
|
||||
## User Problem
|
||||
|
||||
{What user problem does this design solve?}
|
||||
|
||||
## Context
|
||||
|
||||
{Business context, previous attempts, constraints}
|
||||
|
||||
---
|
||||
|
||||
## Requirements
|
||||
|
||||
### Functional Requirements
|
||||
- {Requirement 1}
|
||||
- {Requirement 2}
|
||||
- {Requirement 3}
|
||||
|
||||
### User Flows
|
||||
{What user actions need to be supported?}
|
||||
1. {Flow 1}
|
||||
2. {Flow 2}
|
||||
|
||||
### Constraints
|
||||
- {Technical constraint}
|
||||
- {Brand constraint}
|
||||
- {Platform constraint}
|
||||
|
||||
---
|
||||
|
||||
## Deliverables
|
||||
|
||||
### Required
|
||||
- [ ] Mobile design (320-480px)
|
||||
- [ ] Desktop design (1280px+)
|
||||
- [ ] All interaction states
|
||||
- [ ] Component specifications
|
||||
- [ ] Handoff documentation
|
||||
|
||||
### Optional
|
||||
- [ ] Tablet design (768-1024px)
|
||||
- [ ] Interactive prototype
|
||||
- [ ] Animation specifications
|
||||
- [ ] Micro-interactions
|
||||
|
||||
---
|
||||
|
||||
## Design Assets
|
||||
|
||||
### Figma Links
|
||||
| Asset | Link | Status |
|
||||
|-------|------|--------|
|
||||
| Main Design | {link} | {in progress / complete} |
|
||||
| Prototype | {link} | {in progress / complete / N/A} |
|
||||
| Component Specs | {link} | {in progress / complete} |
|
||||
|
||||
### States Checklist
|
||||
|
||||
| Component | Default | Hover | Active | Focus | Disabled | Loading | Error | Empty |
|
||||
|-----------|---------|-------|--------|-------|----------|---------|-------|-------|
|
||||
| {component} | ☐ | ☐ | ☐ | ☐ | ☐ | ☐ | ☐ | ☐ |
|
||||
| {component} | ☐ | ☐ | ☐ | ☐ | ☐ | ☐ | ☐ | ☐ |
|
||||
|
||||
---
|
||||
|
||||
## Design System
|
||||
|
||||
### Existing Patterns to Use
|
||||
- {Pattern 1}
|
||||
- {Pattern 2}
|
||||
|
||||
### New Patterns Introduced
|
||||
- {New pattern - document in design system}
|
||||
|
||||
### Design Tokens Used
|
||||
| Category | Tokens |
|
||||
|----------|--------|
|
||||
| Colors | {list} |
|
||||
| Spacing | {list} |
|
||||
| Typography | {list} |
|
||||
|
||||
---
|
||||
|
||||
## Accessibility
|
||||
|
||||
- [ ] Color contrast verified (4.5:1 text, 3:1 large)
|
||||
- [ ] Focus states designed
|
||||
- [ ] Touch targets adequate (44px min)
|
||||
- [ ] Color not sole indicator
|
||||
- [ ] Keyboard flow considered
|
||||
|
||||
---
|
||||
|
||||
## Responsive Behavior
|
||||
|
||||
| Breakpoint | Behavior |
|
||||
|------------|----------|
|
||||
| Mobile (<768px) | {description} |
|
||||
| Tablet (768-1024px) | {description} |
|
||||
| Desktop (>1024px) | {description} |
|
||||
|
||||
---
|
||||
|
||||
## Design Decisions
|
||||
|
||||
### Decision 1: {Title}
|
||||
- **Options**: {what was considered}
|
||||
- **Decision**: {what was chosen}
|
||||
- **Rationale**: {why}
|
||||
|
||||
---
|
||||
|
||||
## Frontend Handoff
|
||||
|
||||
### Handoff Checklist
|
||||
- [ ] All states complete
|
||||
- [ ] All breakpoints complete
|
||||
- [ ] Specs documented in Figma
|
||||
- [ ] Interactions documented
|
||||
- [ ] Assets exportable
|
||||
- [ ] Design tokens referenced (not hardcoded values)
|
||||
|
||||
### Implementation Notes
|
||||
{Specific notes for frontend developers}
|
||||
|
||||
### Animations/Transitions
|
||||
{Any animation specifications}
|
||||
|
||||
---
|
||||
|
||||
## QA Review
|
||||
|
||||
### Design QA Checklist
|
||||
- [ ] Design system compliance
|
||||
- [ ] All states present
|
||||
- [ ] Accessibility requirements met
|
||||
- [ ] Responsive designs complete
|
||||
- [ ] Handoff documentation complete
|
||||
|
||||
### QA Notes
|
||||
{Filled in by UX-QA}
|
||||
|
||||
---
|
||||
|
||||
## Quick Context Restore
|
||||
|
||||
**Current state**: Not started
|
||||
**Design progress**: 0%
|
||||
**States complete**: 0/X
|
||||
**Breakpoints complete**: 0/3
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
|
||||
{Additional context, inspiration, user research insights}
|
||||
|
||||
---
|
||||
|
||||
## Changelog
|
||||
|
||||
| Date | Agent | Change |
|
||||
|------|-------|--------|
|
||||
| YYYY-MM-DD | {agent} | Design requested |
|
||||
@@ -0,0 +1,154 @@
|
||||
# TASK-{ID}: {Title}
|
||||
|
||||
> **Template**: Documentation
|
||||
> **Created**: YYYY-MM-DD
|
||||
> **Last Updated**: YYYY-MM-DD
|
||||
|
||||
---
|
||||
|
||||
## Status
|
||||
|
||||
| Field | Value |
|
||||
|-------|-------|
|
||||
| **State** | `pending` |
|
||||
| **Priority** | P{0-3} |
|
||||
| **Cell** | {backend / frontend / ux_ui} |
|
||||
| **Assigned To** | {agent-id or "unassigned"} |
|
||||
| **Source Task** | {TASK-XXX or "standalone"} |
|
||||
|
||||
## Timeline
|
||||
|
||||
| Milestone | Date |
|
||||
|-----------|------|
|
||||
| Created | YYYY-MM-DD |
|
||||
| Started | - |
|
||||
| Draft Complete | - |
|
||||
| Reviewed | - |
|
||||
| Published | - |
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
{What documentation needs to be created or updated?}
|
||||
|
||||
## Trigger
|
||||
|
||||
{What prompted this documentation task?}
|
||||
- [ ] New feature (TASK-XXX)
|
||||
- [ ] Updated feature (TASK-XXX)
|
||||
- [ ] Documentation gap identified
|
||||
- [ ] User feedback
|
||||
- [ ] Other: {specify}
|
||||
|
||||
---
|
||||
|
||||
## Documentation Scope
|
||||
|
||||
### Documents to Create/Update
|
||||
|
||||
| Document | Type | Location | Action |
|
||||
|----------|------|----------|--------|
|
||||
| {doc name} | {API / component / guide / etc.} | {path} | {create / update} |
|
||||
| {doc name} | {type} | {path} | {action} |
|
||||
|
||||
### Content Requirements
|
||||
|
||||
- [ ] {Content area 1}
|
||||
- [ ] {Content area 2}
|
||||
- [ ] {Content area 3}
|
||||
|
||||
---
|
||||
|
||||
## Source Materials
|
||||
|
||||
### From Development Task
|
||||
{If this docs task is from a feature/bugfix}
|
||||
|
||||
- **Source Task**: {TASK-XXX or "N/A"}
|
||||
- **Journey Notes**: {path to journal.md}
|
||||
- **Handoff Notes**: {path to handoff.md}
|
||||
- **Commits**: {list of relevant commits}
|
||||
|
||||
### Reference Materials
|
||||
- {Existing documentation to reference}
|
||||
- {Code to document}
|
||||
- {Figma/design links}
|
||||
- {Conversation links}
|
||||
|
||||
---
|
||||
|
||||
## Documentation Checklist
|
||||
|
||||
### Content
|
||||
- [ ] Accurate - reflects current implementation
|
||||
- [ ] Complete - covers all relevant aspects
|
||||
- [ ] Clear - understandable without prior context
|
||||
- [ ] Examples - includes working examples
|
||||
- [ ] Edge cases - documents limitations and gotchas
|
||||
|
||||
### Format
|
||||
- [ ] Follows documentation style guide
|
||||
- [ ] Proper headings and structure
|
||||
- [ ] Code blocks formatted correctly
|
||||
- [ ] Links working
|
||||
- [ ] Images/diagrams included (if applicable)
|
||||
|
||||
### Review
|
||||
- [ ] Technical accuracy verified
|
||||
- [ ] Spell/grammar checked
|
||||
- [ ] Reviewed by {reviewer or "self-reviewed"}
|
||||
|
||||
---
|
||||
|
||||
## Draft
|
||||
|
||||
{Documentation draft or link to draft location}
|
||||
|
||||
### Document 1: {Title}
|
||||
|
||||
```markdown
|
||||
{Draft content here or in separate file}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Publication
|
||||
|
||||
### Locations
|
||||
{Where will this documentation be published?}
|
||||
|
||||
- [ ] {Location 1: e.g., docs/api/endpoint.md}
|
||||
- [ ] {Location 2: e.g., README.md update}
|
||||
- [ ] {Location 3: e.g., changelog entry}
|
||||
|
||||
### Changelog Entry
|
||||
|
||||
```markdown
|
||||
## [version] - YYYY-MM-DD
|
||||
|
||||
### Documentation
|
||||
- {What was documented}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Quick Context Restore
|
||||
|
||||
**Current state**: Not started
|
||||
**Draft status**: Not started
|
||||
**Review status**: Not reviewed
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
|
||||
{Additional context, style notes, audience considerations}
|
||||
|
||||
---
|
||||
|
||||
## Changelog
|
||||
|
||||
| Date | Agent | Change |
|
||||
|------|-------|--------|
|
||||
| YYYY-MM-DD | {agent} | Documentation task created |
|
||||
@@ -0,0 +1,125 @@
|
||||
# TASK-{ID}: {Title}
|
||||
|
||||
> **Template**: Feature
|
||||
> **Created**: YYYY-MM-DD
|
||||
> **Last Updated**: YYYY-MM-DD
|
||||
|
||||
---
|
||||
|
||||
## Status
|
||||
|
||||
| Field | Value |
|
||||
|-------|-------|
|
||||
| **State** | `pending` |
|
||||
| **Priority** | P{0-3} |
|
||||
| **Cell** | {backend / frontend / ux_ui} |
|
||||
| **Assigned To** | {agent-id or "unassigned"} |
|
||||
| **Created By** | {agent-id} |
|
||||
| **Initiative** | {initiative-id or "standalone"} |
|
||||
|
||||
## Timeline
|
||||
|
||||
| Milestone | Date |
|
||||
|-----------|------|
|
||||
| Created | YYYY-MM-DD |
|
||||
| Claimed | - |
|
||||
| Started | - |
|
||||
| QA Submitted | - |
|
||||
| QA Passed | - |
|
||||
| Docs Complete | - |
|
||||
| Completed | - |
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
{2-3 sentence description of what this feature is and why it's needed}
|
||||
|
||||
## User Story
|
||||
|
||||
**As a** {type of user}
|
||||
**I want** {capability}
|
||||
**So that** {benefit}
|
||||
|
||||
## Context
|
||||
|
||||
{Why is this being built now? What's the business driver? Any relevant background.}
|
||||
|
||||
---
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
- [ ] {Criterion 1 - specific, testable}
|
||||
- [ ] {Criterion 2 - specific, testable}
|
||||
- [ ] {Criterion 3 - specific, testable}
|
||||
- [ ] {Criterion 4 - specific, testable}
|
||||
|
||||
## Out of Scope
|
||||
|
||||
- {What is explicitly NOT included in this task}
|
||||
- {Helps prevent scope creep}
|
||||
|
||||
---
|
||||
|
||||
## Technical Details
|
||||
|
||||
### Approach
|
||||
{High-level technical approach - filled in during planning phase}
|
||||
|
||||
### Key Files
|
||||
{Primary files that will be created/modified}
|
||||
- `path/to/file1`
|
||||
- `path/to/file2`
|
||||
|
||||
### Dependencies
|
||||
- **Blocked by**: {TASK-XXX or "none"}
|
||||
- **Blocks**: {TASK-XXX or "none"}
|
||||
- **Related**: {TASK-XXX or "none"}
|
||||
|
||||
### API Changes
|
||||
{If applicable: new endpoints, changed contracts}
|
||||
|
||||
### Database Changes
|
||||
{If applicable: new tables, migrations}
|
||||
|
||||
---
|
||||
|
||||
## Design Assets
|
||||
|
||||
{For frontend/UX tasks - links to designs}
|
||||
|
||||
- **Figma**: {link or "N/A"}
|
||||
- **Prototype**: {link or "N/A"}
|
||||
- **States Covered**: {list or "N/A"}
|
||||
|
||||
---
|
||||
|
||||
## Commits
|
||||
|
||||
| Commit | Description | Date |
|
||||
|--------|-------------|------|
|
||||
| - | No commits yet | - |
|
||||
|
||||
---
|
||||
|
||||
## Quick Context Restore
|
||||
|
||||
{2-3 sentences that let any agent quickly understand where this task stands. Update this whenever you pause work.}
|
||||
|
||||
**Current state**: Not started
|
||||
**Next action**: Claim and begin planning
|
||||
**Blockers**: None
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
|
||||
{Any additional context, links, references, or considerations}
|
||||
|
||||
---
|
||||
|
||||
## Changelog
|
||||
|
||||
| Date | Agent | Change |
|
||||
|------|-------|--------|
|
||||
| YYYY-MM-DD | {agent} | Task created |
|
||||
@@ -0,0 +1,185 @@
|
||||
# Documentation Handoff: TASK-{ID}
|
||||
|
||||
> **From**: {developer agent-id}
|
||||
> **To**: Documenter
|
||||
> **Date**: YYYY-MM-DD
|
||||
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
{Plain language description of what was built - 2-3 sentences}
|
||||
|
||||
## What Changed
|
||||
|
||||
### New Functionality
|
||||
- {New feature/capability 1}
|
||||
- {New feature/capability 2}
|
||||
|
||||
### Modified Behavior
|
||||
- {Changed behavior 1}
|
||||
- {Changed behavior 2}
|
||||
|
||||
### Breaking Changes
|
||||
- {Breaking change 1} (if any)
|
||||
- None
|
||||
|
||||
---
|
||||
|
||||
## Documentation Needed
|
||||
|
||||
### Required
|
||||
- [ ] {Doc type 1}: {brief description}
|
||||
- [ ] {Doc type 2}: {brief description}
|
||||
- [ ] Changelog entry
|
||||
|
||||
### Optional
|
||||
- [ ] {Additional doc if useful}
|
||||
|
||||
---
|
||||
|
||||
## Key Commits
|
||||
|
||||
| Commit | Description | Key Files |
|
||||
|--------|-------------|-----------|
|
||||
| {hash} | {description} | {files} |
|
||||
| {hash} | {description} | {files} |
|
||||
| {hash} | {description} | {files} |
|
||||
|
||||
---
|
||||
|
||||
## Code Locations
|
||||
|
||||
### New Files
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| `path/to/file.py` | {what it does} |
|
||||
|
||||
### Modified Files
|
||||
| File | What Changed |
|
||||
|------|--------------|
|
||||
| `path/to/file.py` | {what changed} |
|
||||
|
||||
---
|
||||
|
||||
## API Documentation
|
||||
|
||||
{If applicable - provide details for API docs}
|
||||
|
||||
### New Endpoints
|
||||
|
||||
#### `{METHOD} /api/v1/{path}`
|
||||
|
||||
**Description**: {what it does}
|
||||
|
||||
**Authentication**: {auth requirements}
|
||||
|
||||
**Request**:
|
||||
```json
|
||||
{
|
||||
"field": "type - description"
|
||||
}
|
||||
```
|
||||
|
||||
**Response**:
|
||||
```json
|
||||
{
|
||||
"field": "type - description"
|
||||
}
|
||||
```
|
||||
|
||||
**Errors**:
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 400 | {when} |
|
||||
| 401 | {when} |
|
||||
|
||||
---
|
||||
|
||||
## Usage Examples
|
||||
|
||||
{Code examples the documenter should include}
|
||||
|
||||
### Example 1: {Use Case}
|
||||
|
||||
```python
|
||||
# Example code
|
||||
from module import feature
|
||||
|
||||
result = feature.do_thing(param)
|
||||
```
|
||||
|
||||
### Example 2: {Use Case}
|
||||
|
||||
```python
|
||||
# Another example
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Important Conversations
|
||||
|
||||
{Links to important discussions that provide context}
|
||||
|
||||
| Message/Thread | Topic | Key Insight |
|
||||
|----------------|-------|-------------|
|
||||
| {link/reference} | {topic} | {what's important} |
|
||||
|
||||
---
|
||||
|
||||
## Gotchas & Warnings
|
||||
|
||||
{Things the documenter should highlight in docs}
|
||||
|
||||
1. **{Gotcha 1}**: {explanation}
|
||||
2. **{Gotcha 2}**: {explanation}
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
{Existing docs that may need updates}
|
||||
|
||||
- `docs/path/to/related.md` - may need {update type}
|
||||
- `README.md` - {if needs update}
|
||||
|
||||
---
|
||||
|
||||
## Changelog Entry
|
||||
|
||||
Suggested changelog entry:
|
||||
|
||||
```markdown
|
||||
## [{version}] - YYYY-MM-DD
|
||||
|
||||
### Added
|
||||
- {New feature description} (#TASK-{ID})
|
||||
|
||||
### Changed
|
||||
- {Changed behavior} (#TASK-{ID})
|
||||
|
||||
### Fixed
|
||||
- {Bug fix if applicable} (#TASK-{ID})
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Questions for Documenter
|
||||
|
||||
{Any clarifying questions the dev wants to raise}
|
||||
|
||||
1. {Question 1}
|
||||
2. {Question 2}
|
||||
|
||||
---
|
||||
|
||||
## Dev's Journey Notes
|
||||
|
||||
For full context, see: [journal.md](journal.md)
|
||||
|
||||
### Key Learnings Worth Documenting
|
||||
- {Learning that users/devs should know}
|
||||
- {Pattern that's reusable}
|
||||
|
||||
### Decisions Worth Explaining
|
||||
- **{Decision}**: {Why - this helps users understand the design}
|
||||
@@ -0,0 +1,123 @@
|
||||
# Agent Journey: TASK-{ID}
|
||||
|
||||
This file documents the agent's journey through this task. It provides context for future agents, enables handoffs, and builds organizational knowledge.
|
||||
|
||||
---
|
||||
|
||||
## Session 1
|
||||
|
||||
**Date**: YYYY-MM-DD HH:MM
|
||||
**Agent**: {agent-id}
|
||||
**Duration**: ~{X} hours
|
||||
**Session State**: {started / continued / completed / paused}
|
||||
|
||||
### Context Restored
|
||||
{If resuming: how you restored context}
|
||||
|
||||
### What I Did
|
||||
- {Action 1}
|
||||
- {Action 2}
|
||||
- {Action 3}
|
||||
|
||||
### What I Learned
|
||||
- {Learning 1 - something new discovered}
|
||||
- {Learning 2 - something understood better}
|
||||
|
||||
### What I Struggled With
|
||||
- {Struggle 1 - what was difficult}
|
||||
- {Struggle 2 - where I got stuck}
|
||||
|
||||
### Decisions Made
|
||||
- **{Decision}**: {Why I made this choice}
|
||||
|
||||
### Code Notes
|
||||
{Any important notes about the code written}
|
||||
|
||||
```python
|
||||
# Key snippet or reference
|
||||
```
|
||||
|
||||
### Commits This Session
|
||||
| Commit | Description |
|
||||
|--------|-------------|
|
||||
| {hash} | {description} |
|
||||
|
||||
### Progress
|
||||
- [x] {Completed sub-task}
|
||||
- [x] {Completed sub-task}
|
||||
- [ ] {Remaining sub-task}
|
||||
|
||||
### Next Steps
|
||||
When resuming, I should:
|
||||
1. {Next step 1}
|
||||
2. {Next step 2}
|
||||
|
||||
### Session End State
|
||||
{Brief description of where things stand}
|
||||
|
||||
---
|
||||
|
||||
## Session 2
|
||||
|
||||
**Date**: YYYY-MM-DD HH:MM
|
||||
**Agent**: {agent-id}
|
||||
**Duration**: ~{X} hours
|
||||
**Session State**: {started / continued / completed / paused}
|
||||
|
||||
### Context Restored
|
||||
{How context was restored from previous session}
|
||||
|
||||
### What I Did
|
||||
- {Action 1}
|
||||
- {Action 2}
|
||||
|
||||
### What I Learned
|
||||
- {Learning 1}
|
||||
|
||||
### What I Struggled With
|
||||
- {Struggle 1}
|
||||
|
||||
### Decisions Made
|
||||
- **{Decision}**: {Rationale}
|
||||
|
||||
### Commits This Session
|
||||
| Commit | Description |
|
||||
|--------|-------------|
|
||||
| {hash} | {description} |
|
||||
|
||||
### Progress
|
||||
- [x] {Completed sub-task}
|
||||
- [ ] {Remaining sub-task}
|
||||
|
||||
### Next Steps
|
||||
{If more work needed}
|
||||
|
||||
### Session End State
|
||||
{Current state}
|
||||
|
||||
---
|
||||
|
||||
## Summary (For Handoff)
|
||||
|
||||
**Total Sessions**: X
|
||||
**Total Time**: ~X hours
|
||||
**Agents Involved**: {agent-id}, {agent-id}
|
||||
|
||||
### Key Learnings
|
||||
1. {Most important learning}
|
||||
2. {Second most important}
|
||||
3. {Third}
|
||||
|
||||
### Key Decisions
|
||||
1. {Decision 1}: {Why}
|
||||
2. {Decision 2}: {Why}
|
||||
|
||||
### Gotchas for Future Work
|
||||
- {Gotcha 1 - something that tripped you up}
|
||||
- {Gotcha 2 - something to watch out for}
|
||||
|
||||
### Reusable Patterns
|
||||
- {Pattern that could be used elsewhere}
|
||||
|
||||
### Related Tasks
|
||||
- {Related task IDs or topics}
|
||||
@@ -0,0 +1,152 @@
|
||||
# Implementation Plan: TASK-{ID}
|
||||
|
||||
> **Created**: YYYY-MM-DD
|
||||
> **Author**: {agent-id}
|
||||
> **Status**: {draft / approved / in_progress / completed}
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
{High-level description of the approach}
|
||||
|
||||
## Goals
|
||||
|
||||
1. {Primary goal}
|
||||
2. {Secondary goal}
|
||||
|
||||
## Non-Goals
|
||||
|
||||
- {What we're explicitly NOT doing}
|
||||
- {Scope boundaries}
|
||||
|
||||
---
|
||||
|
||||
## Approach
|
||||
|
||||
### Strategy
|
||||
{Explain the overall strategy and why}
|
||||
|
||||
### Key Design Decisions
|
||||
- **{Decision 1}**: {Rationale}
|
||||
- **{Decision 2}**: {Rationale}
|
||||
|
||||
### Alternatives Considered
|
||||
| Alternative | Pros | Cons | Why Rejected |
|
||||
|-------------|------|------|--------------|
|
||||
| {alt 1} | {pros} | {cons} | {why not} |
|
||||
| {alt 2} | {pros} | {cons} | {why not} |
|
||||
|
||||
---
|
||||
|
||||
## Sub-Tasks
|
||||
|
||||
### Phase 1: {Name}
|
||||
**Estimated effort**: {time}
|
||||
|
||||
- [ ] 1.1 {Sub-task}
|
||||
- Notes: {any notes}
|
||||
- [ ] 1.2 {Sub-task}
|
||||
- Notes: {any notes}
|
||||
- [ ] 1.3 {Sub-task}
|
||||
|
||||
### Phase 2: {Name}
|
||||
**Estimated effort**: {time}
|
||||
|
||||
- [ ] 2.1 {Sub-task}
|
||||
- [ ] 2.2 {Sub-task}
|
||||
- [ ] 2.3 {Sub-task}
|
||||
|
||||
### Phase 3: Testing & Cleanup
|
||||
**Estimated effort**: {time}
|
||||
|
||||
- [ ] 3.1 Write/update tests
|
||||
- [ ] 3.2 Run full test suite
|
||||
- [ ] 3.3 Code cleanup
|
||||
- [ ] 3.4 Self-review
|
||||
|
||||
---
|
||||
|
||||
## Technical Details
|
||||
|
||||
### Files to Create
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| `path/to/new/file.py` | {purpose} |
|
||||
|
||||
### Files to Modify
|
||||
| File | Changes |
|
||||
|------|---------|
|
||||
| `path/to/existing/file.py` | {what changes} |
|
||||
|
||||
### Dependencies
|
||||
- {Library/package needed}
|
||||
- {Other task dependency}
|
||||
|
||||
### API Changes
|
||||
{If applicable}
|
||||
|
||||
| Endpoint | Method | Change |
|
||||
|----------|--------|--------|
|
||||
| `/api/v1/example` | POST | New endpoint |
|
||||
|
||||
### Database Changes
|
||||
{If applicable}
|
||||
|
||||
| Table | Change |
|
||||
|-------|--------|
|
||||
| `users` | Add column `preferences` |
|
||||
|
||||
---
|
||||
|
||||
## Testing Strategy
|
||||
|
||||
### Unit Tests
|
||||
- [ ] Test {functionality 1}
|
||||
- [ ] Test {functionality 2}
|
||||
- [ ] Test edge case: {description}
|
||||
|
||||
### Integration Tests
|
||||
- [ ] Test {integration point 1}
|
||||
- [ ] Test {integration point 2}
|
||||
|
||||
### Manual Testing
|
||||
- [ ] Verify {scenario 1}
|
||||
- [ ] Verify {scenario 2}
|
||||
|
||||
---
|
||||
|
||||
## Risks & Mitigations
|
||||
|
||||
| Risk | Probability | Impact | Mitigation |
|
||||
|------|-------------|--------|------------|
|
||||
| {Risk 1} | {low/med/high} | {low/med/high} | {how to mitigate} |
|
||||
| {Risk 2} | {low/med/high} | {low/med/high} | {how to mitigate} |
|
||||
|
||||
---
|
||||
|
||||
## Open Questions
|
||||
|
||||
- [ ] {Question 1}
|
||||
- Answer: {answer when known}
|
||||
- [ ] {Question 2}
|
||||
- Answer: {answer when known}
|
||||
|
||||
---
|
||||
|
||||
## Checkpoints
|
||||
|
||||
| Checkpoint | Criteria | Completed |
|
||||
|------------|----------|-----------|
|
||||
| Plan approved | PM reviewed | ☐ |
|
||||
| Phase 1 complete | Sub-tasks 1.x done | ☐ |
|
||||
| Phase 2 complete | Sub-tasks 2.x done | ☐ |
|
||||
| Tests passing | All green | ☐ |
|
||||
| Self-review done | Checklist complete | ☐ |
|
||||
| Ready for QA | All criteria met | ☐ |
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
|
||||
{Additional planning notes, references, etc.}
|
||||
@@ -0,0 +1,204 @@
|
||||
# QA Review: TASK-{ID}
|
||||
|
||||
> **Reviewer**: {qa agent-id}
|
||||
> **Date**: YYYY-MM-DD
|
||||
> **Verdict**: {PASSED / NEEDS_REVISION / BLOCKED}
|
||||
|
||||
---
|
||||
|
||||
## Review Summary
|
||||
|
||||
| Aspect | Status | Notes |
|
||||
|--------|--------|-------|
|
||||
| Functionality | ✅ / ❌ | {notes} |
|
||||
| Code Quality | ✅ / ❌ | {notes} |
|
||||
| Tests | ✅ / ❌ | {notes} |
|
||||
| Security | ✅ / ❌ | {notes} |
|
||||
| Documentation | ✅ / ❌ | {notes} |
|
||||
|
||||
**Overall Verdict**: {PASSED / NEEDS_REVISION}
|
||||
|
||||
---
|
||||
|
||||
## Acceptance Criteria Verification
|
||||
|
||||
| # | Criterion | Status | Evidence |
|
||||
|---|-----------|--------|----------|
|
||||
| 1 | {criterion from task} | ✅ / ❌ | {how verified} |
|
||||
| 2 | {criterion from task} | ✅ / ❌ | {how verified} |
|
||||
| 3 | {criterion from task} | ✅ / ❌ | {how verified} |
|
||||
|
||||
---
|
||||
|
||||
## Functionality Testing
|
||||
|
||||
### Happy Path
|
||||
| Test Case | Expected | Actual | Status |
|
||||
|-----------|----------|--------|--------|
|
||||
| {test case 1} | {expected} | {actual} | ✅ / ❌ |
|
||||
| {test case 2} | {expected} | {actual} | ✅ / ❌ |
|
||||
|
||||
### Edge Cases
|
||||
| Test Case | Expected | Actual | Status |
|
||||
|-----------|----------|--------|--------|
|
||||
| {edge case 1} | {expected} | {actual} | ✅ / ❌ |
|
||||
| {edge case 2} | {expected} | {actual} | ✅ / ❌ |
|
||||
|
||||
### Error Handling
|
||||
| Scenario | Expected | Actual | Status |
|
||||
|----------|----------|--------|--------|
|
||||
| {error scenario 1} | {expected} | {actual} | ✅ / ❌ |
|
||||
| {error scenario 2} | {expected} | {actual} | ✅ / ❌ |
|
||||
|
||||
---
|
||||
|
||||
## Code Quality Review
|
||||
|
||||
### Code Review Checklist
|
||||
- [ ] Follows project conventions
|
||||
- [ ] No code duplication
|
||||
- [ ] Functions are focused (single responsibility)
|
||||
- [ ] Naming is clear and consistent
|
||||
- [ ] No dead code or commented-out code
|
||||
- [ ] Error handling is appropriate
|
||||
- [ ] Logging is adequate
|
||||
|
||||
### Type Safety
|
||||
- [ ] All types properly defined
|
||||
- [ ] No `any` types (TS) or missing hints (Python)
|
||||
- [ ] Null/undefined handled properly
|
||||
|
||||
### Observations
|
||||
{Any code quality observations}
|
||||
|
||||
---
|
||||
|
||||
## Test Coverage
|
||||
|
||||
### Automated Tests
|
||||
| Category | Before | After | Delta |
|
||||
|----------|--------|-------|-------|
|
||||
| Unit Tests | X | X | +X |
|
||||
| Integration Tests | X | X | +X |
|
||||
| Coverage % | X% | X% | +X% |
|
||||
|
||||
### Test Quality
|
||||
- [ ] Tests cover happy path
|
||||
- [ ] Tests cover error cases
|
||||
- [ ] Tests are readable
|
||||
- [ ] Tests don't have false positives
|
||||
|
||||
### Test Output
|
||||
```
|
||||
{Paste test run output}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Security Review
|
||||
|
||||
### Checklist
|
||||
- [ ] Input validation present
|
||||
- [ ] No sensitive data exposed
|
||||
- [ ] Authentication/authorization correct
|
||||
- [ ] No injection vulnerabilities (SQL, command, etc.)
|
||||
- [ ] No XSS vulnerabilities
|
||||
- [ ] Secrets not hardcoded
|
||||
|
||||
### Findings
|
||||
{Any security observations}
|
||||
|
||||
---
|
||||
|
||||
## Performance Review
|
||||
|
||||
- [ ] No obvious performance issues
|
||||
- [ ] Database queries optimized
|
||||
- [ ] No N+1 query problems
|
||||
- [ ] Appropriate caching considered
|
||||
|
||||
### Observations
|
||||
{Any performance observations}
|
||||
|
||||
---
|
||||
|
||||
## Issues Found
|
||||
|
||||
### Blocking Issues
|
||||
|
||||
#### Issue 1: {Title}
|
||||
**Severity**: {Critical / High}
|
||||
**Location**: `{file:line}`
|
||||
|
||||
**Description**: {What's wrong}
|
||||
|
||||
**Steps to Reproduce**:
|
||||
1. {Step 1}
|
||||
2. {Step 2}
|
||||
|
||||
**Expected**: {What should happen}
|
||||
**Actual**: {What happens}
|
||||
|
||||
**Suggested Fix**: {How to fix, if known}
|
||||
|
||||
---
|
||||
|
||||
#### Issue 2: {Title}
|
||||
{Same format}
|
||||
|
||||
---
|
||||
|
||||
### Non-Blocking Issues
|
||||
|
||||
#### Issue 3: {Title}
|
||||
**Severity**: {Medium / Low}
|
||||
**Location**: `{file:line}`
|
||||
|
||||
**Description**: {What's wrong}
|
||||
|
||||
**Suggestion**: {How to improve}
|
||||
|
||||
---
|
||||
|
||||
## Positive Observations
|
||||
|
||||
{What was done well - positive feedback matters!}
|
||||
|
||||
- {Good thing 1}
|
||||
- {Good thing 2}
|
||||
|
||||
---
|
||||
|
||||
## Suggestions for Future
|
||||
|
||||
{Non-blocking suggestions for improvement}
|
||||
|
||||
- {Suggestion 1}
|
||||
- {Suggestion 2}
|
||||
|
||||
---
|
||||
|
||||
## Verdict Details
|
||||
|
||||
### If PASSED
|
||||
- All acceptance criteria met
|
||||
- No blocking issues
|
||||
- Code quality acceptable
|
||||
- Tests adequate
|
||||
- Ready for documentation
|
||||
|
||||
### If NEEDS_REVISION
|
||||
**Required changes before re-review**:
|
||||
1. {Required change 1}
|
||||
2. {Required change 2}
|
||||
|
||||
**Re-review scope**: {What will be re-checked}
|
||||
|
||||
---
|
||||
|
||||
## Review Log
|
||||
|
||||
| Date | Action | Reviewer |
|
||||
|------|--------|----------|
|
||||
| YYYY-MM-DD | Initial review | {agent} |
|
||||
| YYYY-MM-DD | Re-review after fixes | {agent} |
|
||||
@@ -0,0 +1,181 @@
|
||||
# TASK-{ID}: {Title}
|
||||
|
||||
> **Template**: Research
|
||||
> **Created**: YYYY-MM-DD
|
||||
> **Last Updated**: YYYY-MM-DD
|
||||
|
||||
---
|
||||
|
||||
## Status
|
||||
|
||||
| Field | Value |
|
||||
|-------|-------|
|
||||
| **State** | `pending` |
|
||||
| **Priority** | P{0-3} |
|
||||
| **Cell** | {backend / frontend / ux_ui / board} |
|
||||
| **Assigned To** | {agent-id or "unassigned"} |
|
||||
| **Requested By** | {agent-id} |
|
||||
|
||||
## Timeline
|
||||
|
||||
| Milestone | Date |
|
||||
|-----------|------|
|
||||
| Requested | YYYY-MM-DD |
|
||||
| Started | - |
|
||||
| Findings Documented | - |
|
||||
| Reviewed | - |
|
||||
| Completed | - |
|
||||
|
||||
---
|
||||
|
||||
## Research Question
|
||||
|
||||
{Clear statement of what needs to be researched and why}
|
||||
|
||||
## Context
|
||||
|
||||
{Why is this research needed? What decision will it inform?}
|
||||
|
||||
## Scope
|
||||
|
||||
### In Scope
|
||||
- {Research area 1}
|
||||
- {Research area 2}
|
||||
|
||||
### Out of Scope
|
||||
- {Not researching this}
|
||||
- {Not researching that}
|
||||
|
||||
---
|
||||
|
||||
## Deliverables
|
||||
|
||||
- [ ] Summary of findings
|
||||
- [ ] Recommendation (if applicable)
|
||||
- [ ] {Additional deliverable}
|
||||
- [ ] {Additional deliverable}
|
||||
|
||||
## Success Criteria
|
||||
|
||||
{How will we know the research is complete and sufficient?}
|
||||
|
||||
- [ ] {Criterion 1}
|
||||
- [ ] {Criterion 2}
|
||||
|
||||
---
|
||||
|
||||
## Research Plan
|
||||
|
||||
### Approach
|
||||
{How will this research be conducted?}
|
||||
|
||||
### Sources to Investigate
|
||||
- [ ] {Source 1: e.g., documentation, codebase, external APIs}
|
||||
- [ ] {Source 2}
|
||||
- [ ] {Source 3}
|
||||
|
||||
### Questions to Answer
|
||||
1. {Specific question 1}
|
||||
2. {Specific question 2}
|
||||
3. {Specific question 3}
|
||||
|
||||
### Time Budget
|
||||
{Estimated time allocation - research should be timeboxed}
|
||||
|
||||
---
|
||||
|
||||
## Findings
|
||||
|
||||
{Filled in during research}
|
||||
|
||||
### Key Discoveries
|
||||
|
||||
#### Finding 1: {Title}
|
||||
{Description}
|
||||
- **Source**: {where you found this}
|
||||
- **Confidence**: {high / medium / low}
|
||||
- **Implications**: {what this means}
|
||||
|
||||
#### Finding 2: {Title}
|
||||
{Description}
|
||||
- **Source**: {where you found this}
|
||||
- **Confidence**: {high / medium / low}
|
||||
- **Implications**: {what this means}
|
||||
|
||||
### Data Collected
|
||||
|
||||
{Any data, measurements, or evidence gathered}
|
||||
|
||||
| Data Point | Value | Source |
|
||||
|------------|-------|--------|
|
||||
| {item} | {value} | {source} |
|
||||
|
||||
---
|
||||
|
||||
## Analysis
|
||||
|
||||
### Summary
|
||||
{High-level summary of findings}
|
||||
|
||||
### Options Identified
|
||||
{If research was to inform a decision}
|
||||
|
||||
| Option | Pros | Cons | Effort | Recommendation |
|
||||
|--------|------|------|--------|----------------|
|
||||
| {Option A} | {pros} | {cons} | {effort} | {recommended / not recommended} |
|
||||
| {Option B} | {pros} | {cons} | {effort} | {recommended / not recommended} |
|
||||
|
||||
### Unknowns Remaining
|
||||
{What questions are still unanswered?}
|
||||
|
||||
---
|
||||
|
||||
## Recommendation
|
||||
|
||||
{Final recommendation based on research}
|
||||
|
||||
### Recommended Approach
|
||||
{What should we do?}
|
||||
|
||||
### Rationale
|
||||
{Why this recommendation?}
|
||||
|
||||
### Next Steps
|
||||
- [ ] {Action item 1}
|
||||
- [ ] {Action item 2}
|
||||
|
||||
### Follow-up Tasks
|
||||
{Tasks that should be created based on this research}
|
||||
- {TASK-XXX description}
|
||||
- {TASK-XXX description}
|
||||
|
||||
---
|
||||
|
||||
## References
|
||||
|
||||
{Links to sources, documentation, external resources}
|
||||
|
||||
- {Reference 1}
|
||||
- {Reference 2}
|
||||
|
||||
---
|
||||
|
||||
## Quick Context Restore
|
||||
|
||||
**Current state**: Not started
|
||||
**Research progress**: 0%
|
||||
**Key findings so far**: None yet
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
|
||||
{Additional context, tangential findings, future research ideas}
|
||||
|
||||
---
|
||||
|
||||
## Changelog
|
||||
|
||||
| Date | Agent | Change |
|
||||
|------|-------|--------|
|
||||
| YYYY-MM-DD | {agent} | Research requested |
|
||||
Reference in New Issue
Block a user