Snapshot Prompt
# {{FEATURE_NAME}} — Snapshot Session Prompt > Paste everything below the horizontal rule into a new GitHub Copilot chat session. > Run this ONCE after the planning session generates phase-N.md. > The session reads every file the plan will touch and writes QUICKSTART.md. > You do not need to approve anything — just let it run. --- You are performing a **read-only snapshot** of the **{{FEATURE_NAME}}** feature in the repository at `{{REPO_ROOT}}`. Your goal is to write `{{DESIGN_FOLDER}}/QUICKSTART.md` — a structured snapshot of the current state of the relevant code that implementation sessions will read as context. ## Step 1 — Read the feature design files Read all of these files in full: 1. `{{DESIGN_FOLDER}}/context.md` — project conventions and layout 2. `{{DESIGN_FOLDER}}/architecture.md` — detailed system design (if it exists) 3. `{{DESIGN_FOLDER}}/phase-1.md` — first phase task plan 4. Any other `phase-N.md` files present in `{{DESIGN_FOLDER}}/` These tell you which files the implementation sessions will touch. Collect all **Target file** paths mentioned across the phase plans. ## Step 2 — Read the target files For every **Target file** path found in Step 1, read the full file content. Also read any files listed under **Key files** in `{{DESIGN_FOLDER}}/context.md`. ## Step 3 — Summarize findings Based on your reading, determine: 1. **Current state** — for each area mentioned in the phase plans, what already exists, what is partial, and what is missing. 2. **Key files** — the full repo-relative path of every file that matters, with a one-line note on why. 3. **Gotchas** — anything non-obvious: naming rules the LLM might get wrong, patterns that must be followed exactly, constraints that are easy to violate. 4. **Open questions** — any unresolved design decisions visible in the code or plans. ## Step 4 — Write QUICKSTART.md Write `{{DESIGN_FOLDER}}/QUICKSTART.md` using the template structure already in that file. Rules: - Fill every section with real observations from Step 3 — do not leave placeholder text. - Keep the **Gotchas** section honest: list only things you actually observed, not generic advice. - The **Key files** table must include exact repo-relative paths, not folder-level descriptions. - Set the **Date** in the change log to today's date. - If the project uses third-party libraries with rapidly-evolving APIs, add a **Reference links** section at the end of QUICKSTART.md listing the documentation URLs that implementation sessions should check (Step 5.5 in prompt.md). Only include libraries you found actually imported in the code. ## Step 5 — Report Reply with:
fill the variables
This prompt has 3 variables. Pro fills them into a ready-to-paste prompt for you — no manual find-and-replace.
{{FEATURE_NAME}{{REPO_ROOT}{{DESIGN_FOLDER}
Unlock with Pro →when to use it
Community prompt sourced from the open-source GitHub repo piotrwachowski/questlog (MIT). A "Snapshot Prompt" style prompt — adapt the placeholders and specifics to your task. Imported as-is and not independently retested here, so check the output before relying on it.
tags
roleplaycommunitygeneral
source
piotrwachowski/questlog · MIT