Files
sde-meeting-toolkit/QUICKSTART.md

113 lines
4.1 KiB
Markdown

# Quick Start: SDE Meeting Toolkit
## Open a tool
1. Go to the `tools` folder.
2. Double-click `field-problem-workshop.html` or `scope-lock-meeting-suite.html`.
3. The file opens in your default browser.
No install step is needed for this method.
## Field Problem Workshop
The tool has three panels: Problem Map, Breadcrumbs, Actions.
### Problem Map panel
1. Type a problem into the entry box and click **Add**.
2. Click **Add cluster** to create a new group.
3. Drag a problem into a cluster, or use the cluster picker on the item.
4. Use dot voting to mark priority problems.
5. Unsorted problems stay under **Unclustered** at the top.
### Breadcrumbs panel
1. Click **Add a blank breadcrumb** to start a new one.
2. Fill in **Baseline**, **Method**, **Metric**, and, once you have a baseline, **Target**.
3. Click **Scan for incomplete items** to find breadcrumbs missing a field.
4. Click **Save** on a breadcrumb to lock in your edits.
### Actions panel
1. Click **Add** to create an action item.
2. Assign an owner and a due date.
3. Click **Save** to store the action.
### Save your session
The tool does not save to disk on its own.
1. Click **Save JSON** before you close the tab.
2. Store the file somewhere you can find it.
3. Next time, click **Load JSON** and pick that file to pick up where you left off.
4. Click **Export summary** to produce the meeting write-up (markdown).
5. Click **Reset** only when you want to return to the July 21 baseline (43 problems, 7 clusters, 6 breadcrumbs, 5 actions). Reset erases current data, so export first.
## Scope Lock Meeting Suite
The tool has four panels: Scope Boundary Board, MVP Priority Ranker, Decision Registry, Micron Pilot Readiness.
### Scope Boundary Board
1. Click **Add item** to enter a new scope item.
2. Move it into one of four columns: **In MVP**, **Later Phase**, **Out**, **Parking Lot**.
3. Items start in **Unsorted** until you sort them.
### MVP Priority Ranker
1. Use **Move line up** / **Move line down** to reorder items by priority.
### Decision Registry
1. Click **Log decision** to record a decision made in the meeting.
### Micron Pilot Readiness
1. Review the readiness checklist shown on this panel.
### Save your session
1. This tool autosaves to the browser's local storage on the computer you use. It does not need a manual save step.
2. Local storage does not follow you to another computer or browser.
3. Click **Export meeting summary** to create the durable record to share or file.
4. **Reset all** returns the tool to its starting state. Export first if you want to keep current data.
## Run it from a local server instead
Use this if you want the tools served over HTTP, or if you want the AI draft button to work outside of Claude.
1. Open a terminal in the `sde-meeting-toolkit` folder.
2. Run `npm run serve`.
3. Open `http://localhost:5173` in a browser.
4. Click a tool link on that page, or go directly to a file under `tools`.
## Use the AI draft button
The Field Problem Workshop has an AI draft feature on the Breadcrumbs panel. It calls Claude to draft breadcrumb fields for you. Use one of these two methods.
### Method A: Local server (needs an API key)
1. Copy `.env.example` to a new file named `.env`, in the `sde-meeting-toolkit` folder.
2. Open `.env` and set `ANTHROPIC_API_KEY` to your key.
3. Run `npm run serve`.
4. Open the tool at `http://localhost:5173/tools/field-problem-workshop.html`.
5. Click the AI draft button.
If the button reports a missing key, check that `.env` exists, holds the correct key, and that you restarted the server after editing it.
### Method B: Claude artifact (no key needed)
1. Upload `field-problem-workshop.html` to a Claude chat, or add it to a Claude project.
2. Ask Claude to render it as an artifact.
3. Use the AI draft button from inside that artifact.
If you open the file directly, with no server running, the AI draft button fails. This is expected. Use Method A or Method B instead.
## Install the breadcrumb skill
1. In Claude, open `skills/construction-breadcrumbs.skill`.
2. Use **Save skill** to install it.
3. Start a new chat to use it.
Next: open a tool and click **Add** to create your first item.