CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

typescript-advanced-docs

Documentation tooling for TypeScript projects — JSDoc comment patterns that surface in IDE tooltips, TypeDoc configuration for generating API documentation sites, Architectural Decision Record (ADR) templates for recording design decisions, and framework-specific documentation patterns (NestJS, React, Angular/Compodoc). Use when writing JSDoc for a public API, setting up TypeDoc to generate documentation from source, recording why a technical decision was made, or documenting a framework-specific pattern.

Quality

82%

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

65%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.

Well-structured body with genuine, concrete anti-patterns (BAD/GOOD JSDoc examples, ADR section list) and excellent reference-file organization. The main weaknesses are redundant trigger sections ('When to Apply' / 'Use When' / 'In Scope') that waste tokens, and the absence of an explicit JSDoc-first→TypeDoc workflow with a verify-the-generated-output checkpoint.

Suggestions

Merge 'When to Apply', 'Use When', and 'In Scope' into a single section — three sections currently repeat the same four triggers.

Add a short ordered workflow for the TypeDoc path (write JSDoc on the public API → configure → run npx typedoc → check the rendered output for broken {@link}/@example), making the implicit order and verification explicit.

Include a minimal typedoc.json snippet next to the quick command so the setup step is executable without opening the reference file.

DimensionReasoningScore

Conciseness

The guidance itself is tight and assumes competence (e.g., 'a JSDoc @param restating a parameter's type the signature already shows is noise'), but 'When to Apply', 'Use When', and 'In Scope' three times repeat the same four trigger scenarios in slightly different forms. Not 4: the triple duplication is more than 'minor over-explanation that could be trimmed'; not 2: nothing explains concepts Claude already knows, and the anti-patterns with BAD/GOOD examples earn their tokens.

3 / 5

Actionability

Concrete, executable guidance throughout: a copy-paste command ('npx typedoc --out docs src/index.ts'), complete BAD/GOOD JSDoc code examples, and a specific ADR structure (Context/Decision/Alternatives Considered/Consequences). Not 5: some common cases lack inline specifics — e.g., no minimal typedoc.json snippet or JSDoc example for a NestJS decorator, though these are deferred to the (real) reference files; not 3: what is inline is real code and commands, not pseudocode or hints.

4 / 5

Workflow Clarity

The JSDoc-first-then-TypeDoc ordering is only implied by an anti-pattern ('NEVER configure TypeDoc without first ensuring the source has real JSDoc'), and there is no explicit step sequence or validation checkpoint; the only verification note ('actually running npx typedoc and checking the generated output') lives in 'When NOT to Use' rather than a workflow. Not 4: no clearly listed sequence with checkpoints for the generate-and-publish flow; not 2: the anti-patterns do convey a coherent implicit order and the 'When NOT to Use' section covers misuse.

3 / 5

Progressive Disclosure

Clear overview structure with a References table mapping each of the four topics to a real one-level-deep file (all four exist in references/), each with a 'Covers' description, plus curated external links. Content is appropriately split: principles and anti-patterns inline, bulk detail in the reference files. Matches the anchor-5 pattern exactly.

5 / 5

Total

15

/

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.

A strong description: concrete capabilities, explicit 'Use when...' triggers, third person, and a distinct documentation niche. The only weakness is missing a few natural synonyms (e.g., 'doc comments', 'API docs') that would make trigger-term coverage fully comprehensive.

Suggestions

Add a natural synonym or two such as 'doc comments' or 'API docs' to broaden how users phrase documentation requests.

Consider mentioning 'TSDoc' since users asking about TSDoc-compliant comments would benefit from this skill.

DimensionReasoningScore

Specificity

The description lists multiple specific concrete capabilities — 'JSDoc comment patterns that surface in IDE tooltips, TypeDoc configuration for generating API documentation sites, Architectural Decision Record (ADR) templates... framework-specific documentation patterns (NestJS, React, Angular/Compodoc)' — comprehensively covering the skill's four domains. Not 4: coverage of the skill's scope is complete with no gaps; each capability is named concretely rather than generically.

5 / 5

Completeness

Explicitly answers both questions: 'what' via the four listed capability areas and 'when' via the concrete trigger clause 'Use when writing JSDoc for a public API, setting up TypeDoc to generate documentation from source, recording why a technical decision was made, or documenting a framework-specific pattern.' This matches the anchor-5 example pattern (what + 'Use when...' with concrete triggers) exactly.

5 / 5

Trigger Term Quality

Strong natural keyword coverage — 'JSDoc', 'TypeDoc', 'ADR', 'NestJS', 'React', 'Angular/Compodoc', 'public API', 'API documentation sites' — terms users would actually say. Not 5: a few natural synonyms are missing (e.g., 'doc comments', 'API docs', 'documentation site' as a bare phrase); not 3: far more than partial keyword coverage since every major trigger term a user would utter is present.

4 / 5

Distinctiveness Conflict Risk

Clear niche (TypeScript documentation tooling) with distinct triggers (JSDoc, TypeDoc, ADR, framework docs) — a user asking to 'write JSDoc' or 'set up TypeDoc' would unambiguously land here rather than on a general TypeScript-practices skill. Not 4: no meaningful overlap risk with sibling TypeScript skills since the description scopes strictly to documentation of code, not type design or practices.

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

allowed_tools_field

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

Warning

Total

15

/

16

Passed

Repository

pantheon-org/tekhne

Path

skills/development/typescript-advanced/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.