CtrlK
BlogDocsLog inGet started
Tessl Logo

deprecate-cds-api

Deprecates a CDS component, hook, or other exported symbol with consistent JSDoc, version tags, and docsite metadata across every public export path (web, mobile, common, visualization), not only the original package. Use whenever the user asks to deprecate a CDS component or API, mark something as deprecated, add @deprecated / @deprecationExpectedRemoval, or update deprecation warnings in apps/docs metadata under components or hooks (webMetadata.json / mobileMetadata.json / metadata.json). Also use when replacing a component or hook and sunsetting the old one. Always finish by running `yarn nx run <project>:lint` on modified packages so `internal/deprecated-jsdoc-has-removal-version` passes.

75

Quality

94%

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

88%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-sequenced, actionable deprecation workflow with explicit validation and feedback loops. Its main weakness is repeated restatement of the version-removal policy across several steps and a monolithic single-file structure.

Suggestions

State the full-major-undisturbed (M+2) policy once in Step 2 and reference it from Step 1, Step 3, and Step 5 rather than restating the rationale in each.

Consider extracting the JSDoc/metadata examples and in-repo reference pointers into a references/ file linked from a shorter overview, to reduce SKILL.md length.

The version-table example is tied to specific package versions (9.14.0, 10.0.0); keep these as illustrative but note they are examples so they don't read as time-sensitive current state.

DimensionReasoningScore

Conciseness

Mostly efficient and assumes Claude's competence (no explanation of what JSDoc or Nx is), but the full-major-undisturbed policy is restated across Step 1, Step 2, Step 3, and the Step 5 checklist, which could be tightened.

4 / 5

Actionability

Provides an exact JSDoc template, the required closing sentence, @deprecationExpectedRemoval format, concrete metadata JSON warning strings, file paths, and the executable `yarn nx run <project>:lint` command — copy-paste ready for the common cases.

5 / 5

Workflow Clarity

Clear Step 0–6 sequence with an explicit verification checklist (Step 5) and a required lint feedback loop in Step 6 ('Fix any reported issues before finishing'), satisfying validation for this batch/multi-package operation.

5 / 5

Progressive Disclosure

Well-organized into labeled sections with no nested references and in-repo example pointers at the end, but all content lives inline in SKILL.md with no separate reference files split out for a body this length.

4 / 5

Total

18

/

20

Passed

Description

100%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 specific, trigger-rich, and fully answers both what and when in third person, with concrete file names and a required lint step. It is somewhat long but every clause carries specific information rather than fluff.

DimensionReasoningScore

Specificity

Lists multiple concrete actions — 'consistent JSDoc, version tags, and docsite metadata across every public export path', 'webMetadata.json / mobileMetadata.json / metadata.json', and 'yarn nx run <project>:lint' — giving comprehensive coverage of the deprecation workflow.

5 / 5

Completeness

Explicitly answers both what (deprecate symbols across export paths with JSDoc/tags/metadata and lint) and when ('Use whenever the user asks to deprecate... or update deprecation warnings... Also use when replacing...').

5 / 5

Trigger Term Quality

Captures natural user phrasings — 'deprecate a CDS component or API', 'mark something as deprecated', 'add @deprecated / @deprecationExpectedRemoval', 'update deprecation warnings', and 'replacing a component or hook and sunsetting the old one' — covering synonyms and specific file targets.

5 / 5

Distinctiveness Conflict Risk

Scoped to a clear niche — CDS deprecation across web/mobile/common/visualization packages — with distinct triggers and specific internal tooling, minimizing overlap with other skills.

5 / 5

Total

20

/

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.

Validation14 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

allowed_tools_field

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

Warning

frontmatter_unknown_keys

Unknown frontmatter key(s) found; consider removing or moving to metadata

Warning

Total

14

/

16

Passed

Repository
coinbase/cds
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.