CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

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.

Quality

87%

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

82%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 high-quality conventions skill: nearly every token is a Flet/CrocoDocs-specific rule or copy-paste example rather than generic explanation, and the single-file structure is easy to navigate. Its only weaknesses are minor redundancy between the two admonition sections and the absence of deeper validation/feedback loops beyond the one build-verification note.

DimensionReasoningScore

Conciseness

The body is dense and rule-focused, with almost no explanation of concepts Claude already knows — every rule is a Flet/CrocoDocs-specific convention. Minor trimmable content remains (admonition kinds listed in two sections, the long illustrative sidebar YAML), so it fits 'efficient; minor instances that could be trimmed' rather than the lean 5 anchor.

4 / 5

Actionability

Guidance is copy-paste ready throughout: exact reST role and xref syntax with worked examples, Markdown link formats, front matter YAML, `Image`/`CodeExample` JSX with import statements, and the exact command 'cd website && yarn crocodocs:generate'. Examples cover the common cases for each convention.

5 / 5

Workflow Clarity

This is a conventions/reference skill rather than a fragile multi-step pipeline, and its sections give unambiguous, sequenced guidance (e.g. edit `website/sidebars.yml`, then regenerate). An explicit validation note exists ('verify with a build or `yarn crocodocs:generate`'), but there are no fuller error-recovery loops, matching 'clear sequence with most checkpoints present'.

4 / 5

Progressive Disclosure

The single file is well-organized with clear section headers covering distinct topics, and no bundle files exist to mis-reference or bury. It fits 'good structure; most content appropriately placed; minor organization gaps' — the sidebar-navigation section is sizeable enough that it could arguably live in its own reference file.

4 / 5

Total

17

/

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.

A strong description: it pairs an explicit 'Use when' trigger with a concrete enumeration of the skill's coverage areas, and the Flet-specific framing makes it highly distinct. Minor room to grow in keyword synonyms (e.g. 'docs', 'API docs').

DimensionReasoningScore

Specificity

The description lists several concrete capability areas — 'Python docstrings (Google style, reST roles, admonitions)', 'Markdown docs (cross-references, images, code examples)', and 'sidebar navigation' — rather than generic language. It falls short of the 5 anchor because the actions are area enumerations rather than a comprehensive list of specific concrete actions.

4 / 5

Completeness

It explicitly answers both questions: 'Use when writing or reviewing Flet documentation' states when with concrete trigger phrasing, and the enumerated list of docstring, Markdown, and sidebar areas states what. Not a 4 because the 'when' clause is explicit and domain-specific rather than only adequate.

5 / 5

Trigger Term Quality

Natural keywords users would say are present: 'documentation', 'docstrings', 'Markdown', 'cross-references', 'sidebar navigation'. A few natural variants are missing (e.g. 'docs', 'API docs', 'sidebars'), keeping it below the comprehensive-synonym coverage of the 5 anchor.

4 / 5

Distinctiveness Conflict Risk

'Flet' names a specific framework, giving the skill a clear niche with distinct triggers and minimal conflict risk with other documentation-related skills. It matches the 'clear niche with distinct triggers' anchor.

5 / 5

Total

18

/

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

Path

.agents/skills/docs-conventions/SKILL.md

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.