Du kannst nicht mehr als 25 Themen auswählen Themen müssen mit entweder einem Buchstaben oder einer Ziffer beginnen. Sie können Bindestriche („-“) enthalten und bis zu 35 Zeichen lang sein.

compile-epic-context.md 2.9KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. # Compile Epic Context
  2. **Task**
  3. Given an epic number, the epics file, the planning artifacts directory, and a desired output path, compile a clean, focused, developer-ready context file (`epic-<N>-context.md`).
  4. **Steps**
  5. 1. Read the epics file and extract the target epic's title, goal, and list of stories.
  6. 2. Scan the planning artifacts directory for the standard files (PRD, architecture, UX/design, product brief).
  7. 3. Pull only the information relevant to this epic.
  8. 4. Write the compiled context to the exact output path using the format below.
  9. ## Exact Output Format
  10. Use these headings:
  11. ```markdown
  12. # Epic {N} Context: {Epic Title}
  13. <!-- Compiled from planning artifacts. Edit freely. Regenerate with compile-epic-context if planning docs change. -->
  14. ## Goal
  15. {One clear paragraph: what this epic achieves and why it matters.}
  16. ## Stories
  17. - Story X.Y: Brief title only
  18. - ...
  19. ## Requirements & Constraints
  20. {Relevant functional/non-functional requirements and success criteria for this epic (describe by purpose, not source).}
  21. ## Technical Decisions
  22. {Key architecture decisions, constraints, patterns, data models, and conventions relevant to this epic.}
  23. ## UX & Interaction Patterns
  24. {Relevant UX flows, interaction patterns, and design constraints (omit section entirely if nothing relevant).}
  25. ## Cross-Story Dependencies
  26. {Dependencies between stories in this epic or with other epics/systems (omit if none).}
  27. ```
  28. ## Rules
  29. - **Scope aggressively.** Include only what a developer working on any story in this epic actually needs. When in doubt, leave it out — the developer can always read the full planning doc.
  30. - **Describe by purpose, not by source.** Write "API responses must include pagination metadata" not "Per PRD section 3.2.1, pagination is required." Planning doc internals will change; the constraint won't.
  31. - **No full copies.** Never quote source documents, section numbers, or paste large blocks verbatim. Always distill.
  32. - **No story-level details.** The story list is for orientation only. Individual story specs handle the details.
  33. - **Nothing derivable from the codebase.** Don't document what a developer can learn by reading the code.
  34. - **Be concise and actionable.** Target 800–1500 tokens total. This file loads into quick-dev's context alongside other material.
  35. - **Never hallucinate content.** If source material doesn't say something, don't invent it.
  36. - **Omit empty sections entirely**, except Goal and Stories, which are always required.
  37. ## Error handling
  38. - **If the epics file is missing or the target epic is not found:** write nothing and report the problem to the calling agent. Goal and Stories cannot be populated without a usable epics file.
  39. - **If planning artifacts are missing or empty:** still produce the file with Goal and Stories populated from the epics file, and note the gap in the Goal section. Never hallucinate content to fill missing sections.