CtrlK
BlogDocsLog inGet started
Tessl Logo

docs-writer

Write, review, and edit documentation files with consistent structure, tone, and technical accuracy. Use when creating docs, reviewing markdown files, writing READMEs, updating `/docs` directories, or when user says "write documentation", "review this doc", "improve this README", "create a guide", or "edit markdown". Do NOT use for code comments, inline JSDoc, or API reference generation.

73

Quality

90%

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 concise, well-structured instruction skill that points to a real reference file and provides concrete tooling guidance. The main gap is the absence of an explicit validation/retry feedback loop in the editing workflow.

Suggestions

Add an explicit validate-and-retry loop in Step 4: after re-reading changed files, list specific failure conditions to fix and re-check before finalizing (e.g., broken links -> fix -> re-verify).

Make the actionability of Step 2 sharper by naming the concrete entry points to read (e.g., specific files or index pages under packages/) rather than only the directory.

State how to confirm docs still match the code (e.g., diffing against changed packages/ files) so the verify step is a concrete check rather than a re-read.

DimensionReasoningScore

Conciseness

Lean and efficient with no padding or explanation of concepts Claude already knows; every step instructs and earns its tokens.

5 / 5

Actionability

Concrete guidance including specific tools (replace vs write_file), real paths (references/style-guide.md, docs/sidebar.json), and a concrete command (npm run format), but some steps remain high-level without exact file targets.

4 / 5

Workflow Clarity

Clear numbered 4-step sequence with a verify/finalize step and link verification, but it lacks an explicit validate-then-retry feedback loop for the edits themselves.

4 / 5

Progressive Disclosure

Overview body defers detailed standards to a real one-level-deep reference (references/style-guide.md) that is clearly signaled, with content appropriately split.

5 / 5

Total

18

/

20

Passed

Description

95%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 that explicitly covers what, when, and what-not, with rich natural trigger phrases and a clear scope boundary. The only minor gap is that the action list, while concrete, is not maximally comprehensive.

DimensionReasoningScore

Specificity

Lists several concrete actions ("Write, review, and edit documentation files") applied to a specific artifact, but coverage is not exhaustive enough for a 5.

4 / 5

Completeness

Clearly answers both what (write/review/edit docs) and when (explicit "Use when..." triggers plus a "Do NOT use for" boundary).

5 / 5

Trigger Term Quality

Comprehensive natural-term coverage including synonyms (docs, markdown files, READMEs, /docs) and verbatim user phrases ("write documentation", "review this doc", "improve this README").

5 / 5

Distinctiveness Conflict Risk

Clear documentation niche with distinct triggers and an explicit exclusion clause ("Do NOT use for code comments, inline JSDoc, or API reference generation") minimizing conflict risk.

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.

Validation16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository
tech-leads-club/agent-skills
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.