docs: update analysis template for planner-owned slice shape [doc-updater] - #2798
Conversation
Authored-by: egg
There was a problem hiding this comment.
Approve. Clean documentation sync. The new Open Questions guidance in docs/templates/analysis.md matches the upstream refiner contract introduced in #2796 (commit ff1ee1042):
- The new "do not register" categories — work decomposition / slice-DAG / PR packaging, implementation strategy, API / schema details — mirror the production refiner prompt at
orchestrator/routes/pipelines.py:11518-11537("Out of scope for refine open questions"), the plugin spec atplugins/refine-plan/skills/refine-plan/agents/refiner.md:218-231, and the reviewer-refine NACK rubric atplugins/refine-plan/skills/refine-plan/agents/reviewer-refine.md:65-72. - The advisory-seam framing ("name them in
## Problem Statementor## Constraintsas advisory context — the planner will propose a slice shape from that") is consistent with both the plugin spec and the production prompt's "Advisory seam-listing is fine" section. - The link
[Slice-DAG Implement Phase](../architecture/slice-dag.md)resolves (the file exists; its H1 matches the link text). - No callers or tests assert on the template body;
templates/analysis.mdis referenced only as a navigation pointer fromdocs/index.md,docs/hitl-decisions.md, and the plugin SKILL.md, none of which need to change. The bracket-delimited placeholder structure ([...]) is preserved correctly: opens on line 51, closes on line 70 after the third bullet.
The removed wording about "PR consequence in parentheses" and the "sequential PRs is especially wrong because the slice scheduler does not require sibling slices to serialize" callout is no longer needed — operators don't pick slice shape at refine time anymore, so the refiner has nothing to annotate. Correct deletion.
Non-blocking notes:
docs/templates/analysis.md:66— "Implementation strategy the planner can derive from the analysis (migration approach, fallback design, detector shape)". The production prompt uses "detector design" (line 11532) while this template uses "detector shape". Trivial; both are understandable.- The Out-of-scope list lives inside a single
[...]placeholder spanning lines 51–70 with a bulleted list inside square brackets. That's not a markdown error and matches the prior shape, but if a refiner ever literally interprets the brackets as "delete this entire block when filling in", they'd lose the bulleted guardrails too. Mitigation: the production prompt re-states this guidance outside the template fence (the "How to Populate Open Questions" meta-section), so the refiner sees it either way. No action needed.
— Authored by egg
This comment has been minimized.
This comment has been minimized.
| egg is addressing review feedback... |
Review feedback dispositionsThanks for the thorough review and the approval. Both items in the review are explicitly marked non-blocking, and after checking the production prompt I'm leaving the doc as-is.
No code changes pushed. — Authored by egg |
|
egg feedback addressed. View run logs 1 previous review(s) hidden. |
docs: Update analysis template to reflect planner-owned slice shape
Update documentation to reflect changes from ff1ee10 (Fix #2793):
docs/templates/analysis.mdOpen Questions section previously instructed the refiner to register work-decomposition decisions about slice-DAG shape (e.g. "Single slice", "Two slices in parallel"). That guidance is now wrong — Refiner registers work-decomposition / scope / strategy decisions that belong to the planner #2793 delegates slice/PR packaging decisions to the planner, not the refiner.add-decisionitems about slice shape.Triggered by: #2796
Authored-by: egg