CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

orchardcore-docs-writer

Authors OrchardCore documentation — MkDocs Material pages, module README docs, nav entries, admonitions, tabbed content, and redirects. Use when the user needs to add or edit a docs page, document a new module, build/serve the docs site, or wire a page into the navigation.

72

Quality

91%

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 well-crafted instruction-style skill: concrete paths, templates, and commands throughout, two clearly sequenced workflows, and clean separation between the SKILL.md overview and the docs-structure reference file. The main costs are mild duplication between the workflows and the Quick Reference, and the absence of an explicit build-warning validation loop.

DimensionReasoningScore

Conciseness

The body is efficient — tables, terse gotchas, and code fences with no explanations of concepts Claude already knows — but there is noticeable duplication: the serve/build commands appear in both 'Workflow A: Step 3' and the 'Quick Reference: Toolchain' table, and the module-header convention is stated in three places. This fits 'efficient; minor instances of over-explanation that could be trimmed' rather than the every-token-earns-its-place level of 5.

4 / 5

Actionability

Guidance is fully executable: exact paths ('src/docs/reference/modules/<Name>/README.md'), copy-paste nav YAML, a runnable header template, and concrete commands ('pip install -r src/docs/requirements.txt', 'python -m mkdocs serve', 'python -m mkdocs build'). The remaining described-but-not-shown step (linking from the module index) is a minor, well-specified instruction, matching the 'copy-paste ready; specific examples cover the common cases' anchor.

5 / 5

Workflow Clarity

Both workflows are clearly sequenced — Workflow A in three labeled steps ending in a build/preview checkpoint, Workflow B in four numbered steps — and the Gotchas section supplies error signals ('build warns about pages not in nav', tab indentation pitfalls). It falls short of the score-5 anchor because there is no explicit validate-then-fix loop (e.g., 'run mkdocs build and resolve warnings before finishing'), placing it at 'clear sequence with most checkpoints present; minor validation gaps'.

4 / 5

Progressive Disclosure

The body is a clear overview with a well-signaled, one-level-deep bundle reference ('references/docs-structure.md — full directory map, nav anatomy, extensions, redirects') that exists in the bundle (133 lines) and is not itself a pointer-chain. Detail is appropriately split — the body carries the workflows and conventions, the reference carries the exhaustive structure — and pointers to repo files (mkdocs.yml, AGENTS.md) are clearly labeled, matching the 'clear overview with well-signaled one-level-deep references' anchor.

5 / 5

Total

18

/

20

Passed

Description

92%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: third-person, concrete about deliverables, and equipped with an explicit multi-trigger 'Use when' clause covering authoring, module docs, builds, and navigation. The only improvement space is broader synonym coverage in trigger phrasing.

Suggestions

Add a few natural synonyms to the trigger clause (e.g., 'update the documentation site', 'write a tutorial or guide', 'fix the docs navigation') to widen the trigger net.

Consider mentioning the file types users would name ('README.md', 'mkdocs.yml') to catch requests phrased around those artifacts.

DimensionReasoningScore

Specificity

The description lists multiple concrete authoring actions — 'MkDocs Material pages, module README docs, nav entries, admonitions, tabbed content, and redirects' — with comprehensive coverage of the skill's surface area, matching the 'multiple specific concrete actions' anchor. It is not a level below (4) because coverage goes beyond 'minor gaps'; admonitions, tabs, and redirects are all named explicitly.

5 / 5

Completeness

Both questions are explicitly answered: 'what' via the enumerated deliverables and 'when' via the explicit trigger clause 'Use when the user needs to add or edit a docs page, document a new module, build/serve the docs site, or wire a page into the navigation.' This matches the anchor for clearly and explicitly answering both with concrete trigger phrases, so the cap of 3 for a missing 'Use when' clause does not apply.

5 / 5

Trigger Term Quality

Natural user phrasing is well covered ('add or edit a docs page', 'document a new module', 'build/serve the docs site', 'wire a page into the navigation'), but a few plausible synonyms are missing (e.g., 'documentation site', 'user guide', 'tutorial'). It exceeds the score-3 anchor ('some relevant keywords but missing common variations') while not reaching the comprehensive synonym coverage of 5.

4 / 5

Distinctiveness Conflict Risk

The niche is unambiguous — OrchardCore documentation with MkDocs-specific vocabulary ('nav entries', 'admonitions', 'redirects') — giving it distinct triggers and minimal conflict risk with generic writing or docs skills. It fits the 'clear niche with distinct triggers' anchor rather than the score-4 anchor, which implies residual overlap with closely related 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.

Validation — 16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository

OrchardCMS/OrchardCore

Path

.agents/skills/orchardcore-docs-writer/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.