Skip to content

Teach the Skill to write topics and a description - #178

Merged
raghubetina merged 1 commit into
mainfrom
plan-review-metadata
Nov 8, 2026
Merged

raghubetina merged 1 commit into
mainfrom
plan-review-metadata

Conversation

@raghubetina

@raghubetina raghubetina commented Nov 8, 2026 •

Copy link
Copy Markdown
Contributor

Why

The service now lets a Plan carry review metadata in sketch/0.23: an optional application.description and
application.topics, which group Entities by subject for the person checking the Plan
(firstdraft/firstdraft#1227, merged as d523145a). Analysis warns when a Plan with several Entities has no topics
and suggests groups computed from References. The user's agent writes these keys, so the Skill needs to say how,
and its bundled schema copy has to match the service's.

The modeling guide tells the agent to revise the suggested groups against what the Entities mean, without aiming
for a number of topics. In the diagram study, agents that wrote topics without a seed made more single-table
topics for every model tested than agents that revised the foreign-key groups.

Docs: updated the Skill and its Plan reference and modeling guide; the bundled schema copy and its provenance
follow service d523145a.

Review: Codex, approve (1 round, no findings)

The service now lets a Plan carry review metadata in sketch/0.23: an
application description and topics that group Entities, which help
the person checking the Plan and request no generated behavior. The
bundled schema copy and its digest follow the service revision that
added them.

The modeling guide tells the agent to start from the groups that the
topics warning computes from References, revise them from what the
Entities mean, and name no target number. A number steers the result,
and in the diagram study agents writing topics from scratch produced
more single-table topics than agents revising the computed groups.
Topics also need updating on every Entity rename, like other readable
links, so the guide says so.
@raghubetina
raghubetina marked this pull request as ready for review November 8, 2026 07:01
@raghubetina
raghubetina merged commit 983b066 into main Nov 8, 2026
4 checks passed
raghubetina added a commit that referenced this pull request Nov 8, 2026
Plugin 0.9.1 releases the guidance from #178, which teaches the Skill
to write a Plan's description and topics, with the schema copy that
matches service main. Its requirements in release/compatibility.json
stay the same: API 0.8, CLI 0.9.0, and sketch/0.23, whose new keys are
optional. That makes this a patch release.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant