xml-doc-writer

Write, validate, and improve XML documentation comments in C# source code. Use when asked to add, fix, review, or complete XML docs for C# APIs.

Quality

86%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

Passed

No findings from the security scan

Quality

Content

86%Weight 40%Scale 1-5

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

The content is a tight, well-structured instruction-only workflow with concrete rules and a validation step. Adding a brief worked example and an explicit fix-and-retry loop on validation failure would round out actionability and workflow clarity.

Suggestions

Add a short before/after XML doc example to make the transformation concrete and copy-paste ready.

Make the Validate step an explicit feedback loop: 'If the review finds invalid XML or unresolved cref, fix and re-review before finalizing.'

Consider a one-line checklist summary of the element ordering so the canonical sequence is scannable at a glance.

Dimension	Reasoning	Score
Conciseness	The body is lean and assumes Claude's competence, with no padding or explanation of concepts Claude already knows; every line is actionable instruction.	5 / 5
Actionability	Provides concrete, executable rules (element ordering list, two-space indentation, cref/paramref usage) but lacks a worked before/after example showing a complete XML doc transformation.	4 / 5
Workflow Clarity	A clear four-step sequence with an explicit Validate checkpoint (step 4); validation is present so the missing-validation cap does not apply, but there is no explicit fix-and-retry feedback loop.	4 / 5
Progressive Disclosure	Under 50 lines with no need for external references and well-organized section/subsection headers, meeting the simple-skill exception for a top score.	5 / 5
	Total	18 / 20 Passed

Description

87%Weight 40%Scale 1-5

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

The description is concise, concrete, and clearly answers both what the skill does and when to invoke it, with a distinct C#-XML-docs niche. Minor gaps in trigger synonyms and file extensions keep trigger-term coverage just below comprehensive.

Dimension	Reasoning	Score
Specificity	Lists three concrete actions ("Write, validate, and improve") on a specific domain ("XML documentation comments in C# source code"), which is above the 1-2-action anchor but short of comprehensive coverage.	4 / 5
Completeness	Explicitly answers both what ("Write, validate, and improve XML documentation comments in C# source code") and when ("Use when asked to add, fix, review, or complete XML docs for C# APIs") with concrete trigger phrases.	5 / 5
Trigger Term Quality	"add, fix, review, or complete XML docs for C# APIs" are natural phrases users would say, with good coverage but missing synonyms and file extensions like .cs.	4 / 5
Distinctiveness Conflict Risk	Targets a narrow, well-defined niche (C# XML documentation) with distinct triggers, creating minimal overlap risk with other skills.	5 / 5
	Total	18 / 20 Passed

Validation

100%

Warnings & errors only

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository: dotnet/macios
Path: .github/skills/xml-doc-writer/SKILL.md
Commit: d259b5f

Reviewed: 7 days ago

Table of Contents

Discovery Implementation Validation

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.