CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

writing-docs

Use when writing, restructuring, or reviewing any prose documentation — a tutorial, how-to guide, reference page, or explanation/conceptual doc — for a public docs site (e.g. Mintlify MDX, docs/, README material), a getting-started guide, an API/CLI reference page, or a "why we built it this way" conceptual page. Applies the Diátaxis framework (see https://diataxis.fr/) — every document belongs to exactly one of the four quadrants (tutorial / how-to guide / reference / explanation), and mixing quadrants inside one document is the single most common documentation failure. Covers the four-quadrant compass for picking the right form, per-quadrant structure templates, an anti-pattern list for quadrant drift, and generic voice/craft rules — repo-specific voice and target output format (e.g. Mintlify MDX) are resolved from the repo's docs-manifest (falling back to project-context), never hardcoded here.

Quality

86%

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

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 skill's operational content — templates, compass, anti-patterns, voice resolution, and a pre-publish checklist — is excellent and fully actionable. Its weakness is token efficiency: substantial sections re-teach the Diátaxis framework itself, which Claude already knows, inflating the file without adding operational value.

Suggestions

Cut or compress the 'Why Diátaxis' section and the closing cooking analogy — they restate the canonical source Claude already knows; keep only the operational compass table and decision questions.

Reduce each quadrant's prose description to the one-line table entry and fold any unique operational rules (e.g. the ADR-linking rule) into the templates, letting the structure templates carry the real guidance.

Consider moving the four per-quadrant structure templates into a references/ file (one per quadrant) linked from a short overview, shortening what loads into context on every invocation.

DimensionReasoningScore

Conciseness

The operational core (templates, anti-pattern table, voice-resolution order, em-dash rule, checklist) is dense and earns its tokens, but sizable stretches re-explain the Diátaxis framework Claude already knows — the "Why Diátaxis" section, the four quadrant prose descriptions ("A lesson, not a demo…", "A recipe for someone who already knows the basics…"), and the closing cooking analogy all restate the canonical source. That is more than "some unnecessary explanation" but the padded material is confined to identifiable sections rather than pervading the whole, so it sits between the 2 and 3 anchors, at 3.

3 / 5

Actionability

Fully actionable for an instruction-only skill: copy-paste-ready per-quadrant templates with exact frontmatter fields and TODO(fill) sentinels, a two-question compass with a decision table, an anti-pattern table pairing each failure with a concrete fix, a prioritized resolution order (docs-manifest → project-context → stated default), and the precise em-dash delimiter rule. No vague hand-waving anywhere.

5 / 5

Workflow Clarity

The task sequence is legible — pick the quadrant via the compass, use that quadrant's template, resolve voice/format at the start, then run the Self-Review Checklist as an explicit pre-publish validation gate. Not a 5: the overall drafting workflow is implied by section order rather than stated as a numbered procedure, and the checklist has no fix-and-recheck loop for failed items; not a 3 because the compass and checklist do provide real decision and validation checkpoints.

4 / 5

Progressive Disclosure

A single-file skill with no references/, scripts/, or assets/ bundle; the body is well-sectioned with clear headers, and the inlined templates and anti-pattern table are working material needed at drafting time rather than "advanced" content that belongs in separate files. Minor gap: roughly a third of the body (the Diátaxis primer and analogy) is contextual background that could be externalized or cut, keeping it below the top anchor.

4 / 5

Total

16

/

20

Passed

Description

91%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: concrete capabilities, comprehensive natural trigger terms across all four documentation forms, and explicit what/when structure. Its main weakness is verbosity — the final clause about repo-specific resolution mechanics adds length without adding user-facing capability.

DimensionReasoningScore

Specificity

Lists several concrete capabilities — "writing, restructuring, or reviewing any prose documentation", "Applies the Diátaxis framework", "four-quadrant compass for picking the right form, per-quadrant structure templates, an anti-pattern list for quadrant drift, and generic voice/craft rules" — with only minor coverage gaps. Not a 5: the trailing clause about repo-specific resolution being "never hardcoded here" is implementation meta-commentary rather than a capability, and the sheer length pads rather than adds concrete actions.

4 / 5

Completeness

Explicitly answers both questions: what it does ("Applies the Diátaxis framework… Covers the four-quadrant compass… per-quadrant structure templates, an anti-pattern list… voice/craft rules") and when to use it ("Use when writing, restructuring, or reviewing any prose documentation — a tutorial, how-to guide, reference page, or explanation/conceptual doc"). Concrete trigger phrases match the 5-anchor example pattern.

5 / 5

Trigger Term Quality

Comprehensive natural-term coverage: "tutorial", "how-to guide", "reference page", "explanation/conceptual doc", "docs site", "README", "getting-started guide", "API/CLI reference page", plus platform terms like "Mintlify MDX". A user asking to write or review any of these doc forms would naturally use one of these phrases; no common synonym is obviously missing.

5 / 5

Distinctiveness Conflict Risk

The Diátaxis framing and enumerated doc types carve a clear niche distinct from code-comment or general writing skills, and "reviewing… prose documentation" triggers are specific. Minor overlap risk remains with adjacent skills (e.g. a README-only or ADR-writing skill — ADR exclusion is stated only in the body, not the description), so it sits at the "mostly distinct" anchor rather than 5.

4 / 5

Total

18

/

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.

Validation — 16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository

whimzyLive/nightshift-ai

Path

plugins/sdlc/skills/writing-docs/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.