Skip to content

Commit 790dcd8

Browse files
committed
cmd/ghsearchdump: improve prompt
1 parent 3bd87d1 commit 790dcd8

File tree

1 file changed

+37
-6
lines changed

1 file changed

+37
-6
lines changed

pkg/cmd/kv/ghsearchdump/prompt.md

Lines changed: 37 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,59 @@
22

33
Use this prompt with an LLM to generate a monthly progress summary from the JSON output of `ghsearchdump`.
44

5+
**Recommended Model:** Claude Opus 4.5 (`claude-opus-4-5-20251101`) - exceptional at narrative writing and strategic synthesis.
6+
57
---
68

79
You are helping write a monthly progress summary for a software engineering team.
810

911
I have JSON containing PRs worked on this month (attached). Please help me create a ~400 word narrative summary suitable for inclusion in a larger milestone document.
1012

11-
Requirements:
12-
- Write in narrative prose, not bullet lists (e.g., "Wenyi went deep on X and fixed Y")
13-
- Attribute work to authors by first name (map: wenyihu6=Wenyi, tbg=Tobias, sumeerbhola=Sumeer, angeladietz=Angela)
13+
**Focus on project advancement, not individual git logs:**
14+
- Lead with team-level outcomes and what projects advanced (e.g., "Our most notable output this month was...")
15+
- Explain strategic context: why work matters, what problems it solves, how it fits into larger goals
16+
- Discuss priority adjustments, trade-offs, and "side quests" that emerged
17+
- Include honest assessment of challenges, learning curves, and constraints faced
18+
- Cover meta-work: planning sessions, backlog reviews, epic closures with realistic assessments
19+
- Mention individuals by first name only when their specific expertise or leadership is relevant (map: wenyihu6=Wenyi, tbg=Tobias, sumeerbhola=Sumeer, angeladietz=Angela)
20+
21+
**Technical requirements:**
22+
- Write in narrative prose, not bullet lists or per-person summaries
1423
- Use inline markdown links for Jira compatibility: `[#12345](https://github.com/...)`
15-
- Group PRs thematically behind descriptions, not one link per PR
24+
- Group PRs thematically behind descriptions as evidence, not one link per PR
1625
- Extract Epic IDs using `/Epic[:\s]+CRDB-(\d+)/i` to identify major workstreams
17-
- Focus on outcomes and themes, not individual PR details
1826
- Skip bot comments, CI noise, and mechanical changes
1927

20-
Tone: Technical but readable for engineering leadership. Emphasize what was accomplished and why it matters.
28+
Tone: Technical but readable for engineering leadership. Write like you're explaining project status to stakeholders who care about outcomes, strategy, and realistic progress—not just a list of completed tasks.
2129

2230
---
2331

32+
## Example Output
33+
34+
Here's an example that demonstrates the desired style—focused on project advancement, strategic context, and honest assessment rather than individual contributions:
35+
36+
> Our small team's most notable output this month was work to align the existing allocator's lease-count balancing for replicas and leases with the multi-metric allocator, in order to prevent thrashing. We are pleased to report that this works.
37+
>
38+
> We also spent a lot of time poring over the behavior of existing simulation tests together, to understand details of both the old allocator and mma. It's a steep learning curve, we are accelerating and making many useful testing, interpretability, and observability improvements along the way. Still, we expect to continue spending significant amounts of time in this area, paying down the cognitive debt that has built up in this area of the product and making it more accessible to newcomers.
39+
>
40+
> We also began a small but important side quest to disable "follow the workload" lease rebalancing by default (in 26.1+), more background here. By removing this somewhat obscure feature, we would facilitate a (future) full transition off the old allocator. We still need to work through the deprecation plan, so please reach out to us if you have thoughts on this.
41+
>
42+
> October also included virtual and in-person planning, so significant amounts of energy went into a backlog review, as well as formulating a plan for the multi-metric allocator in 26.1 and beyond. (TLDR: cloud preview of the multi-metric allocator).
43+
>
44+
> We will be closing out our 25.4 epic as PARTIAL. We have met the main goal of a master non-production version of the multi-metric allocator that performs the basic advertised functions, but had hoped to have addressed a number of additional work items related to production readiness at this point. Given the substantial non-project (mainly reactive support and admission control onboarding) burden that the team had to shoulder and the thin staffing, we are content with what we have achieved.
45+
46+
Note how this example:
47+
- Leads with team outcomes ("Our small team's most notable output")
48+
- Explains why work matters ("in order to prevent thrashing", "facilitate a future full transition")
49+
- Honestly discusses challenges ("steep learning curve", "cognitive debt")
50+
- Mentions priority shifts ("side quest to disable...")
51+
- Covers planning and meta-work ("backlog review", "formulating a plan")
52+
- Provides realistic epic assessment ("PARTIAL" with clear context on constraints)
53+
2454
## Tips
2555

2656
- Attach the JSON file generated by `ghsearchdump` to your prompt
2757
- You may need to iterate: ask for condensing, different formatting, or additional links
2858
- Consider a two-phase approach: first get a thematic analysis, then write your own narrative and ask the LLM to "add relevant PR links"
59+
- Reference the example above when prompting: "Write in a style similar to the example provided"
2960

0 commit comments

Comments
 (0)