CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

technical-writing

Write, edit, review, or audit user-facing documentation for the eve repository. Use for changes under docs/, documentation tied to eve APIs or CLI behavior, docs work based on Slack or support feedback, and requests to make eve docs clearer, more natural, or less AI-patterned while verifying claims against current source, tests, CLI help, public releases, and repository conventions.

Quality

89%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide
SecuritybySnyk

Low

Low-risk findings worth noting

SKILL.md
Quality
Evals
Security

Quality

Content

85%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 well-structured, repo-specific instruction set with excellent workflow sequencing, explicit validation checkpoints, and a clean one-level-deep reference architecture. Its minor weaknesses are a few over-packed compound bullets and a couple of directives whose execution depends on reading a referenced file rather than the body itself.

Suggestions

Split multi-rule bullets (e.g., the orphan-link rule and the naming-distinction rules in 'Follow eve conventions') into shorter single-rule lines so each directive scans and trims faster.

Inline one minimal example of a well-formed doc section (opening, minimal example, rules) in the body so the feature-page shape is actionable without first reading references/content-types.md.

Make reference-dependent steps self-sufficient by naming the concrete action to take (e.g., 'Run the review passes in references/review-framework.md' → 'Run the five review passes in references/review-framework.md, fixing blockers before style nits').

DimensionReasoningScore

Conciseness

The body is dense with eve-specific rules and assumes Claude's competence — it never explains what documentation is or how it works. A few compound bullets (the orphan-link rule, the naming-distinction rules) pack multiple rules into single sentences and could be trimmed or split, which matches 'efficient; minor instances of over-explanation' rather than the every-token-earns-its-place ideal of a 5.

4 / 5

Actionability

Guidance is concrete and executable: exact commands ('Run `pnpm docs:check`'), exact paths ('packages/eve', 'docs/meta.json', 'research/'), and exact public names ('defineAgent', 'eve dev', 'eve add channel/slack'). It falls short of fully copy-paste-ready coverage because directives like 'Run the review workflow' and 'Check changed prose against the prose-quality reference' require following a reference file to execute, and no inline example of a well-formed doc section is given.

4 / 5

Workflow Clarity

'Finish the change' is a 7-step numbered checklist with explicit validation checkpoints (re-read every changed page, verify each new technical claim against its source, search for contradictory statements, confirm inbound links) plus a concrete final verification command and error-recovery rules ('Never leave `[VERIFY]` markers'). Task routing in 'Choose a workflow' is unambiguous. This matches the clear-sequence-with-explicit-validation anchor rather than the 4 anchor, which allows minor validation gaps.

5 / 5

Progressive Disclosure

The body is an ~84-line overview whose 'Choose a workflow' section points to six purpose-labeled reference files (writing-workflow, editing-workflow, review-framework, style-rules, prose-quality, content-types), each verified to exist with real content. References are one level deep, clearly signaled by use case, and details are appropriately offloaded — matching the top anchor exactly.

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.

The description is a strong example: it states concrete capabilities, gives an explicit multi-scenario 'Use for' trigger clause, and is tightly scoped to the eve repository, making it highly distinguishable. The only minor weakness is that a few natural trigger synonyms (guide, tutorial) are absent.

DimensionReasoningScore

Specificity

Lists multiple concrete actions — 'Write, edit, review, or audit user-facing documentation' plus 'verifying claims against current source, tests, CLI help, public releases, and repository conventions' — comprehensively covering the documentation workflow. This matches the comprehensive-coverage anchor; it is not a 4 because the action set has no significant coverage gaps.

5 / 5

Completeness

Explicitly answers 'what' ('Write, edit, review, or audit user-facing documentation for the eve repository') and 'when' via a concrete 'Use for' clause enumerating four trigger scenarios. Both are clearly and explicitly stated with concrete trigger phrases, matching the top anchor.

5 / 5

Trigger Term Quality

Includes strong natural phrases users would say: 'changes under docs/', 'eve docs', 'Slack or support feedback', 'clearer, more natural, or less AI-patterned', 'eve APIs or CLI behavior'. A few natural variations are missing (e.g., 'guide', 'tutorial', 'how-to page'), so it fits 'good keyword coverage; a few natural terms missing' rather than the comprehensive synonym coverage of a 5.

4 / 5

Distinctiveness Conflict Risk

Scoped tightly to 'the eve repository' with eve-specific triggers (docs/ paths, eve APIs, eve CLI, Slack/support feedback about eve), establishing a clear niche with minimal conflict risk against generic writing or documentation skills.

5 / 5

Total

19

/

20

Passed

Validation

87%

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

Validation — 14 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

metadata_version

'metadata.version' is missing

Warning

metadata_field

'metadata' should map string keys to string values

Warning

Total

14

/

16

Passed

Repository

vercel/eve

Path

.agents/skills/technical-writing/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.