CtrlK
BlogDocsLog inGet started
Tessl Logo

write-docs

Use when writing or editing documentation pages (concept pages, how-to guides, API reference prose, tutorials) under docs/. Provides the writing style, voice, and structural rules for Agenta docs. Apply this skill before drafting any new docs page, and include it in the brief for any subagent tasked with writing docs.

69

Quality

87%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide
SecuritybySnyk

Medium

Suggest reviewing before use

SKILL.md
Quality
Evals
Security

Quality

Content

82%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 high-quality, opinionated style guide: nearly every rule is paired with concrete BAD/GOOD examples or exact commands, and shipping includes real validation steps (docs build, ruff, live-API shape verification). The main weaknesses are length for a single SKILL.md with no reference files, and a topical rather than procedural ordering that leaves the draft-to-ship workflow implicit.

Suggestions

Move the section 8 auto-generated MDX backstory and the subagent brief template into a references/ file (e.g. references/subagent-brief.md) and link to them, keeping SKILL.md as a leaner overview with one-level-deep references.

Add an explicit ordered workflow at the top (pick type, draft, verify claims against code/API, build/lint, ship) so the numbered rule sections read as a reference consulted at each step rather than the only implied sequence.

Add a validate-fix-retry loop to section 9 (e.g. "If the docs build fails, fix the errors and rerun until it passes before committing") to make the feedback loop explicit rather than implied by "fix any errors".

DimensionReasoningScore

Conciseness

Dense rule-per-line content with almost no explanation of concepts Claude already knows (Diátaxis is a compact table, not an essay), and the BAD/GOOD examples each earn their place. Not a 5: at ~250 lines there are passages that could be trimmed, e.g. the three long "Real failures caught in review" bullets in the verification section and some restated rules ("Do not overdo it on simple content" vs. later "Only actions on the page").

4 / 5

Actionability

Fully concrete guidance throughout: exact commands ("git checkout origin/<base-branch> -- docs/docs/reference/api/", "ruff format" then "ruff check --fix", "npm run build" in docs/), copy-pasteable mount and apt-get examples, placeholder UUIDs, a fill-in subagent brief template, and BAD/GOOD pairs for nearly every stylistic rule. It is an instruction-only skill and the guidance is specific and executable without code scaffolding.

5 / 5

Workflow Clarity

A usable sequence exists (pick doc type first in section 1, write per sections 2-8, ship via section 9's validation: run docs build and fix errors, ruff format/check, verify request/response shapes against the live API, revert auto-generated MDX before committing). Not a 5: the numbered sections read more as a topical rulebook than an explicit draft-to-ship workflow, and there is no explicit validate-fix-retry loop (e.g. what to do when the docs build fails beyond "fix any errors").

4 / 5

Progressive Disclosure

No bundle files exist (references/, scripts/, assets/ are all absent), so everything is inline in a well-sectioned, numbered 0-10 structure with clear headings, plus a clearly labeled subagent brief template and clearly signaled pointers (".claude/skills/create-changelog-announcement/SKILL.md", "tmp-docs-analysis/plan.md"). Not a 5: at ~250 lines, candidates for one-level-deep reference files exist (the section 8 auto-generated-content backstory and the subagent brief template), which would keep the main file leaner.

4 / 5

Total

17

/

20

Passed

Description

87%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 where, with concrete page-type triggers and a useful subagent-delegation cue. Third-person voice is used correctly and there is no fluff. Minor upside remains in naming additional natural synonyms (guide, manual, .mdx).

DimensionReasoningScore

Specificity

Names the domain and several concrete capabilities: "writing or editing documentation pages (concept pages, how-to guides, API reference prose, tutorials)" and "Provides the writing style, voice, and structural rules for Agenta docs". Falls short of a 5 because it describes what the skill contains rather than enumerating multiple distinct actions it performs.

4 / 5

Completeness

Explicitly answers both: what ("Provides the writing style, voice, and structural rules for Agenta docs") and when ("Use when writing or editing documentation pages ... under docs/", plus "Apply this skill before drafting any new docs page"). The when is concrete and includes explicit trigger phrases and even a delegation trigger ("include it in the brief for any subagent tasked with writing docs").

5 / 5

Trigger Term Quality

Strong natural keywords users would say: "writing or editing documentation pages", "concept pages", "how-to guides", "API reference prose", "tutorials", "docs", "drafting any new docs page". A few natural synonyms are missing (e.g., "user guide", "manual", ".mdx"), which keeps it below the comprehensive anchor 5.

4 / 5

Distinctiveness Conflict Risk

Clear niche: Agenta docs under docs/, scoped by page types (concept, how-to, API reference prose, tutorials). It is written in third person ("Provides", "Apply") and is unlikely to fire for unrelated skills; the only nearby skill (changelog announcements) is distinguishable by its page-type triggers.

5 / 5

Total

18

/

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

allowed_tools_field

'allowed-tools' contains unusual tool name(s)

Warning

Total

15

/

16

Passed

Repository
Agenta-AI/agenta
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.