Roll Implementation–Documentation Alignment into the Documentation dimension - #13834
JanProvaznik with Copilot wants to merge 2 commits into
Conversation
Agent-Logs-Url: https://github.com/dotnet/msbuild/sessions/032a52d6-730a-4474-9b68-5ddc4b03f863 Co-authored-by: JanProvaznik <25267098+JanProvaznik@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds a new review dimension to the @expert-reviewer methodology to explicitly check that behavior changes and their documentation updates land together, and updates the related skill metadata to reflect the expanded 25-dimension framework.
Changes:
- Added Dimension #25: Implementation–Documentation Alignment (Severity: MAJOR) to the expert reviewer agent methodology.
- Updated all methodology count references/examples from 24 → 25 in the agent doc.
- Updated the
reviewing-msbuild-codeskill description/invocation text to reference the 25-dimension methodology and include the new alignment dimension.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
.github/agents/expert-reviewer.agent.md |
Introduces Dimension #25 and updates count/math/examples to reflect 25 total dimensions. |
.github/skills/reviewing-msbuild-code/SKILL.md |
Updates the skill metadata and invocation line to match the 25-dimension methodology. |
|
@copilot could this be rolled into the documentation dimension? |
… 24 dimensions Co-authored-by: JanProvaznik <25267098+JanProvaznik@users.noreply.github.com>
Head branch was pushed to by a user without write access
Yes — done in 489ceb5. I folded the alignment rules and checks into dimension #18, renamed it to Documentation Accuracy & Alignment, removed the separate dimension #25, and reverted all counts back to 24 (frontmatter, intro, batch math, summary-table examples, and SKILL.md). |
Context
The expert reviewer's 24-dimension methodology had no dimension explicitly checking that code changes ship with the corresponding doc updates in the same PR. Existing dimension #18 (Documentation Accuracy) covered general doc quality (XML comments, spec completeness,
learn.microsoft.comURLs) but didn't target alignment — the case where a behavior change lands without updating the wiki/spec/XML-doc/sample that describes the old behavior. Rather than add a separate dimension for this, the alignment checks are folded into the existing documentation dimension so both concerns live in one place.Changes Made
.github/agents/expert-reviewer.agent.md. In addition to the original accuracy rules, it now covers: behavior changes requiring matching updates under../../documentation/wiki/,../../documentation/specs/,../../documentation/*.md, and affected READMEs; XML doc comments on touched members reflecting new semantics; stale code comments above edited code; ChangeWave additions updatingChangeWaves.md; new/changedMSBxxxxcodes synced with docs that enumerate them; spec updates over contradicting new specs; and full sweeps when renames or defaults change so half-updated docs aren't left behind. Doc references use the consistent../../documentation/relative path form used elsewhere in the file.description, intro line, Wave 1 batch math, and Wave 4 summary-table examples remain at 24..github/skills/reviewing-msbuild-code/SKILL.md: description and invocation line stay at the 24-dimension methodology, with "documentation accuracy and alignment" reflected in the category list.Testing
N/A — spec/skill text only; no code, build, or test changes.
Notes
Alignment checking is now part of dimension #18 instead of a standalone dimension: the same dimension asks both "is the doc well-written and accurate in isolation" and "did this PR keep code and docs in sync".