CtrlK
BlogDocsLog inGet started
Tessl Logo

doc-example-formatting

Format code examples in markdown documentation for TalkPipe. Use when writing or editing doc examples. Covers unindented fences, standalone vs fragment intent, and skip-extract. Complements run-documentation-examples which runs the examples.

82

1.16x
Quality

76%

Does it follow best practices?

Impact

93%

1.16x

Average score across 3 eval scenarios

SecuritybySnyk

Passed

No findings from the security scan

Fix and improve this skill with Tessl

tessl review fix ./.cursor/skills/doc-example-formatting/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

75%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 body is concise, actionable, and well-structured with concrete examples and a validation step appropriate for a single-purpose formatting skill. Tightening the redundancy between 'Good vs Bad' and 'Avoid' and showing the nested-backtick anti-pattern concretely would lift it further.

Suggestions

Merge or trim the overlapping 'Good vs Bad' and 'Avoid' sections (nested backticks and missing language tags appear in both) to reduce redundancy.

Show the nested-backtick anti-pattern concretely instead of only describing it, to strengthen actionability.

DimensionReasoningScore

Conciseness

Largely lean with concrete code and brief 'Why' notes, but the 'Good vs Bad' and 'Avoid' sections repeat earlier guidance (e.g., nested backticks) that could be consolidated.

4 / 5

Actionability

Provides concrete runnable code, a specific validation command, and the '# skip-extract' directive, with minor gaps such as the abstract 'code here' in a bad example.

4 / 5

Workflow Clarity

Single-purpose skill with a clear validation checkpoint ('pytest tests/test_doc_examples.py -v'), though content is organized as reference rules rather than an explicit sequenced workflow.

4 / 5

Progressive Disclosure

Well-organized with clear section headers and one clearly-signaled one-level-deep reference, with minor redundancy between the 'Good vs Bad' and 'Avoid' sections.

4 / 5

Total

16

/

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.

The description is concrete and well-scoped, naming specific formatting concerns and an explicit Use-when trigger, with clear distinctiveness from its complementary runner skill. Trigger coverage and the breadth of actions could be expanded slightly to reach the top anchor.

Suggestions

Add file extensions and synonyms to the trigger clause (e.g., 'when writing or editing markdown (.md) doc examples') to improve trigger term coverage.

Broaden the 'when' clause with additional concrete triggers (e.g., 'when adding code snippets to README, guides, or API docs') to push completeness toward 5.

DimensionReasoningScore

Specificity

Lists several specific concrete actions ('unindented fences', 'standalone vs fragment intent', 'skip-extract') with minor gaps in breadth compared to the fully comprehensive 5-anchor.

4 / 5

Completeness

Clearly states both what ('Format code examples in markdown documentation for TalkPipe') and when ('Use when writing or editing doc examples'), but the 'when' trigger is somewhat narrow compared to the multi-trigger 5-anchor.

4 / 5

Trigger Term Quality

Includes natural user phrases like 'writing or editing doc examples' but misses common synonyms and file extensions such as '.md' or 'markdown'.

4 / 5

Distinctiveness Conflict Risk

Occupies a clear narrow niche (formatting doc examples) and explicitly disambiguates from the related 'run-documentation-examples' skill, minimizing conflict risk.

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.

Validation15 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

relative_links

Relative link issues: 1 missing, 1 deeper-than-1-level

Warning

Total

15

/

16

Passed

Repository
sandialabs/talkpipe
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.