CtrlK
BlogDocsLog inGet started
Tessl Logo

dart-write-documentation

Rules and formatting guidelines for writing Dart /// API documentation and doc comments. Use when documenting Dart code, writing doc comments for any Dart declaration (libraries, classes, methods, variables, etc.), or when instructed to follow the Effective Dart documentation guidelines.

73

Quality

90%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

SecuritybySnyk

Passed

No findings from the security scan

SKILL.md
Quality
Evals
Security

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.

A tightly written, highly actionable reference for Dart doc comments that pairs every rule with concrete Bad/Good examples and a verification step. It stays efficient and well-structured with only minor conciseness and feedback-loop refinements possible.

Suggestions

Trim the Contents block (lines 8-16): for a skill this compact, the in-page anchor index is a token cost that adds little navigation value.

Add a brief error-recovery note in Section 6: what to do when `dart analyze` reports unresolved `comment_references` (e.g., fix the bracketed identifier or add an `@docImport`).

Tighten a few rules that restate the rule name in the explanation (e.g., the 'Avoid redundancy' bullet) to further reduce token overhead.

DimensionReasoningScore

Conciseness

Lean rule-based bullet structure that assumes Claude's knowledge and avoids concept preamble; the Contents index and a few phrasing choices could be trimmed, but nearly every token earns its place.

4 / 5

Actionability

Concrete, executable guidance throughout (exact openers, [ClassName.new] syntax, @docImport placement, dart analyze command) reinforced by paired Bad/Good Dart code examples for each rule.

5 / 5

Workflow Clarity

Section 6 provides a clear sequenced verification process (dart analyze then optional dart doc); not a destructive/batch operation so no cap applies, but error-recovery feedback loops are minimal.

4 / 5

Progressive Disclosure

A self-contained instruction skill with no need for external references; it is well-organized into clearly headed sections with a Contents index, meeting the simple-skill bar for full marks.

5 / 5

Total

18

/

20

Passed

Description

95%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.

A strong, well-scoped description that clearly communicates both purpose and trigger conditions for Dart documentation work. Minor room to sharpen the action verbs, but trigger and distinctiveness coverage are excellent.

DimensionReasoningScore

Specificity

Names the Dart domain and concrete actions (writing/formatting /// doc comments) with several declaration types listed, but the verbs remain fairly general rather than enumerating many distinct concrete operations.

4 / 5

Completeness

Explicitly states both what (rules and formatting guidelines for writing Dart /// API documentation) and when ('Use when documenting Dart code, writing doc comments...'), with concrete trigger phrases.

5 / 5

Trigger Term Quality

Covers natural phrasing a user would say ('documenting Dart code', 'writing doc comments') plus technical terms and the 'Effective Dart documentation guidelines' reference, with comprehensive declaration-type coverage.

5 / 5

Distinctiveness Conflict Risk

Scoped tightly to Dart /// doc comments and the Effective Dart guidelines, giving it a clear niche with minimal overlap against generic documentation skills.

5 / 5

Total

19

/

20

Passed

Validation

100%

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

Validation16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository
flutter/agent-plugins
Reviewed

Table of Contents

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.