CtrlK
BlogDocsLog inGet started
Tessl Logo

docs-conventions

Use when writing or reviewing Flet documentation, including Python docstrings (Google style, reST roles, admonitions), Markdown docs (cross-references, images, code examples), and sidebar navigation.

68

Quality

86%

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

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

An excellent conventions skill: dense, example-driven, and free of filler, with concrete executable snippets and explicit do/don't rules for every documented construct. The only notable gaps are validation guidance limited to the xref section and a single ~200-line file where a one-level-deep reference split could improve progressive disclosure.

Suggestions

Add a brief verify step for the other edit types (e.g. run the docs build or yarn crocodocs:generate after front-matter, image, or code-example changes), mirroring the xref verification guidance.

Consider splitting the three linking-form rule lists (reST roles, xrefs, Markdown links) into a references/ file, keeping SKILL.md as a shorter overview with one-level-deep pointers.

DimensionReasoningScore

Conciseness

The body is lean and dense: every section is rules plus a short verifiable example, with no padding and no explanation of concepts Claude already knows (no 'what Markdown is', no library intros). Even the comparative 'When to prefer over the other forms' bullets state only decision-relevant deltas. This matches the 'every token earns its place' anchor.

5 / 5

Actionability

Guidance is copy-paste ready throughout: executable reST-role and xref snippets, Markdown-link examples, docstring admonition samples, front-matter YAML, `<Image>`/`<CodeExample>` JSX with import lines, sidebar YAML, and the concrete regeneration command 'cd website && yarn crocodocs:generate'. The 'Rules' and 'Not supported' lists resolve the common ambiguity cases (qualified vs local refs, no parens in targets, custom labels unsupported).

5 / 5

Workflow Clarity

Each task is presented as an unambiguous single action, and the sidebar section has a clear two-step sequence (edit sidebars.yml → regenerate with yarn crocodocs:generate); the xref section also supplies a verification checkpoint ('verify with a build or yarn crocodocs:generate'). It falls short of a 5 because validation guidance is only stated for xrefs — image, code-example, and front-matter edits get no equivalent verify step, and there is no error-recovery loop.

4 / 5

Progressive Disclosure

The body is well organized into clearly headed, self-contained sections (docstrings, reST roles, xrefs, Markdown links, admonitions, front matter, images, code examples, inline HTML, sidebars) with no nested or buried references and no monolithic wall of text. Since no bundle files exist and the content is a coherent conventions reference of moderate length, inline placement is defensible; it does not reach a 5 because the rules tables for the three linking forms are lengthy enough that a references/ split (e.g. a linking-formats detail file) would keep the overview even leaner.

4 / 5

Total

18

/

20

Passed

Description

78%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-targeted description: it names a specific niche (Flet documentation), provides an explicit 'Use when...' trigger, and enumerates concrete coverage areas. The main gap is that the 'what' is expressed as an inclusion list rather than explicit capability statements, and a few natural trigger synonyms are absent.

Suggestions

Lead with a concrete capability statement (e.g. 'Apply Flet documentation conventions for...') before the 'Use when' clause so the 'what' is explicit rather than implied by the inclusion list.

Add a few natural trigger variations users might say, such as 'API docs' or 'docstrings', to widen keyword coverage.

DimensionReasoningScore

Specificity

The description enumerates several concrete capability areas — 'Python docstrings (Google style, reST roles, admonitions)', 'Markdown docs (cross-references, images, code examples)', and 'sidebar navigation' — going beyond generic naming. It stops short of a 5 because the verbs ('writing or reviewing') are generic and the description enumerates topics rather than distinct concrete actions.

4 / 5

Completeness

It has an explicit 'Use when writing or reviewing Flet documentation' trigger clause plus a detailed enumeration of what the skill covers, so both what and when are present. The 'what' is implied through the inclusion list rather than stated as a concrete capability statement (e.g. what it actually does with those elements — apply conventions), so it does not fully reach the explicit dual-answer of a 5.

4 / 5

Trigger Term Quality

Strong natural keywords within the niche: 'Flet', 'documentation', 'docstrings', 'Markdown docs', 'cross-references', 'code examples', 'sidebar navigation' — terms a user asking about Flet docs would plausibly say. A few natural variations are missing (e.g. 'API docs', 'docs', 'docstring' singular vs the fuller phrase), keeping it below the comprehensive-synonym level of a 5.

4 / 5

Distinctiveness Conflict Risk

The 'Flet' qualifier pins it to a clear niche with distinct triggers (Flet docs, docstrings, sidebars), making conflict with generic documentation or coding skills very unlikely. It matches the 'clear niche with distinct triggers; minimal conflict risk' anchor exactly.

5 / 5

Total

17

/

20

Passed

Validation

93%

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

Validation — 15 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

relative_links

Relative link issues: 4 suspicious

Warning

Total

15

/

16

Passed

Repository
flet-dev/flet
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.