PMFlow/docs/architecture/TASK_BRIEF_TEMPLATE.md

123 lines
2.9 KiB
Markdown

# Task Brief
本模板用于 PMFlow Codex 单线程或并行 Packet 分派。并行任务必须填写 `Read Scope / Write Scope / Forbidden Paths`;没有 `write_scope` 的任务不允许并行执行。
大模块并行时,`Module Lane` 表示长期产品表面归属,例如 `Shell / Integration`、`Main Flow / PMFlow OS`、`Space`、`Account Settings`。`Packet` 仍是实际执行单位;不能只填写模块名后直接开工。
## Meta
- Packet ID: `{{PACKET_ID}}`
- Module Lane: `Shell / Integration | Main Flow / PMFlow OS | Space | Account Settings | Other`
- Phase: `{{PHASE}}`
- Owner: `{{OWNER}}`
- Lane Owner: `{{LANE_OWNER}}`
- Integration Owner: `{{INTEGRATION_OWNER}}`
- Generated At: `{{GENERATED_AT}}`
- Base Ref: `{{BASE_REF}}`
- Head Ref: `{{HEAD_REF}}`
- Target Branch / Worktree: `{{TARGET_BRANCH_OR_WORKTREE}}`
- Commit Strategy: `{{COMMIT_STRATEGY}}`
- Commit Gate: `auto_commit / hold_no_commit / ask_before_commit`
- Depends On: `{{DEPENDS_ON}}`
- Merge After: `{{MERGE_AFTER}}`
## Goal
{{GOAL}}
## Current Truth Source
{{CURRENT_TRUTH_SOURCE}}
## Target Object / Contract
{{TARGET_OBJECT_OR_CONTRACT}}
## Module Boundary
- Lane Responsibility:
{{LANE_RESPONSIBILITY}}
- Cross-lane Inputs:
{{CROSS_LANE_INPUTS}}
- Cross-lane Outputs:
{{CROSS_LANE_OUTPUTS}}
- Shared Shell / Route / Navigation Impact:
{{SHELL_ROUTE_NAV_IMPACT}}
- If shared files are needed, owner approval / dependency:
{{SHARED_OWNER_APPROVAL_OR_DEPENDENCY}}
## Scope
- Read Scope:
{{READ_SCOPE}}
- Write Scope:
{{WRITE_SCOPE}}
- Forbidden Paths:
{{FORBIDDEN_PATHS}}
- Shared Files Touched:
{{SHARED_FILES_TOUCHED}}
## Change Flags
- API Change: `yes/no` - {{API_CHANGE_DETAIL}}
- Schema Change: `yes/no` - {{SCHEMA_CHANGE_DETAIL}}
- Migration Change: `yes/no` - {{MIGRATION_CHANGE_DETAIL}}
- Runtime Boundary Change: `yes/no` - {{RUNTIME_BOUNDARY_DETAIL}}
- Feature Flag: {{FEATURE_FLAG}}
## Implementation Notes
{{IMPLEMENTATION_NOTES}}
## Risks
{{RISKS}}
## Rollback Plan
{{ROLLBACK_PLAN}}
## Verification Commands
- Backend: `{{BACKEND_VERIFICATION}}`
- Frontend: `{{FRONTEND_VERIFICATION}}`
- Migration: `{{MIGRATION_VERIFICATION}}`
- Focused: `{{FOCUSED_VERIFICATION}}`
## Docs To Sync
{{DOCS_TO_SYNC}}
## Integration Notes
- Integration Owner: `{{INTEGRATION_OWNER}}`
- Module Lane Merge Group: `{{MODULE_LANE_MERGE_GROUP}}`
- Merge Order: `{{MERGE_ORDER}}`
- Expected Commit(s): `{{EXPECTED_COMMITS}}`
- Out-of-scope Findings:
{{OUT_OF_SCOPE_FINDINGS}}
## Delivery Checklist
- [ ] `base_ref` recorded
- [ ] `read_scope` and `write_scope` declared
- [ ] `forbidden_paths` checked
- [ ] Module lane declared
- [ ] Cross-lane inputs/outputs declared
- [ ] Shared shell/router/nav impact declared
- [ ] Shared files reserved or assigned to integration owner
- [ ] Code completed
- [ ] Contracts synchronized
- [ ] Docs synchronized
- [ ] Verification passed
- [ ] Commit gate decision recorded
- [ ] Packet commit created after verification
- [ ] Integration gate passed