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.

91

1.16x
Quality

90%

Does it follow best practices?

Impact

93%

1.16x

Average score across 3 eval scenarios

SecuritybySnyk

Passed

No findings from the security scan

SKILL.md
Quality
Evals
Security

Quality

Content

88%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 a lean, actionable reference for a simple skill: concrete rules, executable examples, and a validation step with the exact command. The main improvement opportunity is consolidating the duplicated anti-patterns in "Good vs Bad" and "Avoid".

DimensionReasoningScore

Conciseness

The body is efficient with concrete rules and examples, no padding about concepts Claude already knows. Not 5 because the "Avoid" section largely restates the "Good vs Bad" section (nested backticks and missing language tags each appear twice), which could be trimmed.

4 / 5

Actionability

Every rule comes with a concrete example: executable Python snippets, the literal `# skip-extract` directive with a worked block, and the exact validation command `pytest tests/test_doc_examples.py -v` plus a variant for skipping Ollama tests. Matches the fully executable, copy-paste-ready anchor; not 4 because the common cases are covered with no gaps.

5 / 5

Workflow Clarity

This is a single-action skill (format the fences) and the action is unambiguous, with an explicit validation checkpoint ("After editing docs, run the doc examples to verify they execute") and the exact command to do so. The simple-skill exception applies and the validation step is present, so it meets the top anchor rather than stopping at 4.

5 / 5

Progressive Disclosure

Sections are well-organized with headers, and the single external pointer ("See docs/architecture/documentation-formatting.md for full guidelines") is clearly signaled and one level deep. Not 5 because there is a small amount of duplicated inline content (Good vs Bad vs Avoid) that keeps organization from being fully clean, and no bundle files exist to split it into.

4 / 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.

The description is a strong example: it states concrete capabilities, gives an explicit 'Use when' trigger, and explicitly delineates the boundary with the related run-documentation-examples skill. Its only weakness is a few missing natural synonyms (e.g., "code blocks", "snippets") in the trigger phrasing.

DimensionReasoningScore

Specificity

"Format code examples in markdown documentation for TalkPipe... Covers unindented fences, standalone vs fragment intent, and skip-extract" lists multiple concrete actions covering the skill's full scope. Matches the anchor for comprehensive specific concrete actions; not 4 because coverage of the skill's topics (fences, intent, skip-extract) is complete rather than having minor gaps.

5 / 5

Completeness

"Format code examples in markdown documentation for TalkPipe" clearly answers what, and "Use when writing or editing doc examples" explicitly answers when with a concrete trigger phrase. Matches the anchor for both what and when with concrete triggers; not 4 because the when-clause is explicit rather than needing more specificity.

5 / 5

Trigger Term Quality

"markdown documentation", "doc examples", "writing or editing doc examples" are natural phrases a user would say, giving good keyword coverage. Not 5 because common variations like "code blocks", "snippets", or "README" that the body itself targets are absent from the description.

4 / 5

Distinctiveness Conflict Risk

The TalkPipe scope, specific topics (unindented fences, skip-extract), and the explicit boundary "Complements run-documentation-examples which runs the examples" carve out a clear niche with minimal conflict risk. Not 4 because the adjacent skill is explicitly disambiguated rather than just implied.

5 / 5

Total

19

/

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: 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.