К основному содержанию
скилл CX Codex

dx-review — скилл для Claude Code: что делает и как установить

Скилл dx-review анализирует публичный API библиотеки с точки зрения удобства для разработчиков. Находит шероховатости в типах TypeScript, сигнатурах методов и обработке ошибок.

MIT 1 установок ★ 1 855 обновлён 2026-10-26

Установить в Claude Code · Через Skills CLI (Vercel) Все способы и платформы ↓
npx skills add LibPDF-js/core --skill dx-review -a claude-code
Открыть на GitHub

Что делает dx-review

Скилл оценивает интерфейс библиотеки глазами внешнего разработчика. Если область проверки не задана в диалоге, агент берёт основной публичный API и исследует имена методов, предсказуемость возвращаемых типов и дефолтные параметры. Анализ опирается на критерии читаемости, эргономики, полезности сообщений об ошибках, точности типов TypeScript, наличия JSDoc и соответствия стандартам платформы.

В процессе проверки агент изучает определения типов, отслеживает типовые пользовательские сценарии и ищет лишний шаблонный код. Итоговый отчёт скилл сохраняет в файл .agents/scratch/dx-review-<scope>.md. В отчёте каждая найденная проблема сопровождается уровнем критичности, категорией, примером неудобного вызова и кодом с рекомендацией по исправлению.

Какие задачи решает

  • проверить эргономику и предсказуемость публичного API библиотеки
  • выявить неточные типы TypeScript и пробелы в автодополнении
  • найти лишний бойлерплейт в типичных сценариях вызова
  • сформировать структурированный отчёт с примерами кода до и после правки

Примеры запросов агенту

  • Проверь DX основного публичного API библиотеки
  • Оцени эргономику модуля работы с формами и сохрани отчёт
  • Проанализируй типы TypeScript и удобство обработки ошибок в текущем API

Как установить dx-review

1Через Skills CLI (Vercel)

npx skills add LibPDF-js/core --skill dx-review -a claude-code

2Вручную: положить файлы

~/.claude/skills/dx-review/SKILL.md

Папка скилла целиком; для одного проекта — .claude/skills/dx-review/

По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов

Вопросы о dx-review

Как установить dx-review в Claude Code?

Выполните команду npx skills add LibPDF-js/core --skill dx-review -a claude-code.

Что оценивает скилл dx-review?

Он проверяет публичный API по семи направлениям: согласованность имён, точность типов TypeScript, удобство типичных сценариев, информативность ошибок, документацию в коде, находимость методов и соответствие платформенным стандартам.

Куда сохраняются результаты ревью?

Агент записывает отчёт в файл .agents/scratch/dx-review-<scope>.md, где указывает уровень критичности для каждой проблемы и приводит варианты кода для исправления.

Исходный текст

SKILL.md · MIT
---
name: dx-review
description: Review developer experience and API ergonomics
---

You are reviewing the developer experience (DX) of the library to ensure it feels good to use. As a library consumed by other developers, ergonomics matter as much as functionality.

## Your Task

1. **Identify scope** - Based on the conversation context, determine what module or feature to review. If no specific scope is mentioned, review the main public API.
2. **Analyze the API surface** - How do developers interact with this code?
3. **Evaluate ergonomics** - Is it intuitive, consistent, and pleasant to use?
4. **Report findings** - Document issues and recommendations

## DX Evaluation Criteria

### 1. Discoverability

- Can developers find what they need?
- Are method names intuitive and searchable?
- Is the API surface appropriately sized (not too sprawling)?

### 2. Consistency

- Do similar operations work the same way?
- Are naming conventions consistent across the API?
- Do return types follow predictable patterns?

### 3. Ergonomics

- Is the common case easy? (pit of success)
- Are required parameters actually required?
- Do defaults make sense for typical usage?
- Is there unnecessary boilerplate?

### 4. Error Experience

- Are errors actionable? (tells you what went wrong AND how to fix it)
- Do errors surface at the right time? (fail fast)
- Are error types specific enough to catch programmatically?

### 5. Type Experience

- Does autocomplete guide developers?
- Are types precise (not too wide like `any` or `string`)?
- Do generics add value or just complexity?

### 6. Documentation in Code

- Are public methods documented with JSDoc?
- Do examples in comments actually work?
- Are parameter constraints documented?

### 7. Comparison to Standards

- How does this compare to similar libraries developers know?
- Does it follow platform conventions (Node.js, Web APIs)?
- Would a developer's intuition from other libraries apply here?

## Review Process

### Step 1: Use the API

Put yourself in a consumer's shoes:

- What would a developer try first?
- What questions would they have?
- Where would they get stuck?

### Step 2: Read the Types

Examine the TypeScript definitions:

- What does autocomplete show?
- Are overloads clear or confusing?
- Do type errors make sense?

### Step 3: Trace Common Workflows

Walk through typical tasks:

- Opening a PDF and reading metadata
- Modifying form fields
- Saving changes
- Handling errors

### Step 4: Look for Friction

Identify pain points:

- Unnecessary ceremony or boilerplate
- Confusing parameter orders
- Inconsistent patterns
- Missing conveniences

## Output Format

Write your review to `.agents/scratch/dx-review-<scope>.md`:

````markdown
# DX Review: <Scope>

## Summary

Overall assessment and top priorities.

## What's Working Well

- Positive patterns to preserve

## Issues Found

### Issue 1: <Title>

**Severity:** High/Medium/Low
**Category:** Discoverability/Consistency/Ergonomics/Errors/Types/Docs

**Problem:**
Description of the issue from a developer's perspective.

**Example:**

```typescript
// Current awkward usage
```

**Recommendation:**

```typescript
// Proposed improvement
```

### Issue 2: ...

## Recommendations Summary

Prioritized list of changes to improve DX.

## Comparison Notes

How we compare to pdf-lib, pdfjs, or other libraries developers might know.

```

## Guidelines

- **Be specific** - Vague feedback isn't actionable
- **Show, don't tell** - Include code examples
- **Prioritize** - Not all issues are equal
- **Be constructive** - Propose solutions, not just problems
- **Consider tradeoffs** - Note when fixing one thing might hurt another
- **Think like a user** - You're advocating for developers who will use this

## Begin

Review the scope determined from the conversation context (or the main API if unspecified) and document your DX findings.
```
````

© LibPDF-js · MIT · LibPDF-js/core

Похожие скиллы

Все скиллы по теме «Код-ревью и рефакторинг» →
public-api-design-review Samuel Berthe Скилл public-api-design-review проводит REST API, готовый или ещё на бумаге, по чек-листу из восьми разделов и делит находки на обязательные правки и улучшения. CX Codex +1 10 200установок plan-devex-review garrytan Скилл plan-devex-review для Claude Code разбирает план developer experience в диалоге. Он включается для ревью DX и проверки онбординга разработчиков. CX Codex +1 378установок pit-of-success jnsahaj Скилл pit-of-success находит скрытые ловушки в коде и перестраивает интерфейсы так, чтобы очевидный вызов разработчика автоматически соблюдал все инварианты. CX Codex +1 137установок api-review gjkim42 Скилл api-review проверяет дизайн Kubernetes API и CRD в проекте Kelos на совместимость и соглашения. Помогает оценить изменения перед слиянием прямо в чате. CX Codex +1 4 800установок api-design margelo Скилл api-design помогает проектировать и проверять публичные API библиотек на TypeScript, JavaScript, React и React Native. CX Codex +1 1 400установок design rainmanjam Скилл design для Claude Code помогает спроектировать типы и API так, чтобы некорректные состояния нельзя было выразить. Включается при создании нового интерфейса. CX Codex +1 ★ 26звёзд репо

Спонсоры проекта

Компании, которые помогают держать аналитику открытой