# typescript-docs

Создаёт документацию TypeScript с JSDoc, TypeDoc и ADR. Пригодится для описания API, решений по архитектуре и кода на популярных фреймворках.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 4200 установок · ★ 363
- Автор: giuseppe-trisciuoglio
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/giuseppe-trisciuoglio/developer-kit/tree/HEAD/plugins/developer-kit-typescript/skills/typescript-docs/SKILL.md
- Обновлён: 2026-09-10
- HTML: https://affpapa.org/nevibecode/skills/typescript-docs

## Что делает

Скилл помогает подготовить JSDoc для функций, классов, интерфейсов и обобщённых типов. Он охватывает теги `@param`, `@returns`, `@throws`, `@example`, `@remarks`, `@see` и `@deprecated`, а также предлагает примеры для React, NestJS, Express, Angular и Vue.

Для справочника API скилл настраивает TypeDoc: точкой входа может быть `src/index.ts`, а результат размещается в `docs/api`. В примере конфигурации приватные члены исключаются через `excludePrivate`, поэтому внутренняя часть классов не попадёт в опубликованную справку. Это повод проверить, не нужен ли команде отдельный внутренний документ.

Также скилл создаёт ADR по структуре «статус, контекст, решение, последствия», добавляет правила ESLint для описаний и примеров, а также сценарий GitHub Actions для генерации и проверки документации. Для Angular указан `npx compodoc -p tsconfig.json`; проверка JSDoc запускается командой `eslint --ext .ts src/`.

## Установка

### Claude Code (родная платформа)

1. **Через Skills CLI (Vercel)**
```bash
npx skills add giuseppe-trisciuoglio/developer-kit --skill typescript-docs -a claude-code
```

2. **Вручную: положить файлы**
- Файл: `~/.claude/skills/typescript-docs/SKILL.md` — Папка скилла целиком; для одного проекта — .claude/skills/typescript-docs/

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add giuseppe-trisciuoglio/developer-kit --skill typescript-docs -a codex
```

2. **Вручную: положить файлы**
- Файл: `.agents/skills/typescript-docs/SKILL.md` — Для всех проектов — ~/.agents/skills/

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add giuseppe-trisciuoglio/developer-kit --skill typescript-docs -a cursor
```

2. **Вручную: положить файлы**
- Файл: `.cursor/skills/typescript-docs/SKILL.md` — Cursor читает и .agents/skills/, и .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install giuseppe-trisciuoglio/developer-kit typescript-docs
```

2. **Вручную: положить файлы**
- Файл: `.github/skills/typescript-docs/SKILL.md`

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add giuseppe-trisciuoglio/developer-kit --skill typescript-docs -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/giuseppe-trisciuoglio/developer-kit --path plugins/developer-kit-typescript/skills/typescript-docs
```

### Windsurf (Devin Desktop)

**Вручную: положить файлы**
- Файл: `.devin/skills/typescript-docs/SKILL.md` — Старый путь .windsurf/skills/ тоже читается

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add giuseppe-trisciuoglio/developer-kit --skill typescript-docs -a opencode
```

### Claude.ai

**Claude.ai**
- Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/giuseppe-trisciuoglio/developer-kit/tree/HEAD/plugins/developer-kit-typescript/skills/typescript-docs/SKILL.md

## Когда брать
- описать публичный TypeScript API через JSDoc
- сгенерировать справочник API с TypeDoc
- зафиксировать архитектурное решение в ADR
- проверить описания параметров и результатов через ESLint
- добавить генерацию документации в GitHub Actions

## Примеры запросов агенту
- Подготовь JSDoc для публичных классов и функций в `src/`.
- Настрой TypeDoc для `src/index.ts` и выведи справочник в `docs/api`.
- Создай ADR для решения включить строгий режим TypeScript.

## Похожие
- [jsdoc-typescript-docs](https://affpapa.org/nevibecode/skills/jsdoc-typescript-docs.md) — скилл · 547 установок
- [typescript](https://affpapa.org/nevibecode/skills/mindrally-typescript.md) — скилл · 955 установок
- [api-docs](https://affpapa.org/nevibecode/skills/api-docs.md) — скилл · 891 установка
- [typescript-discriminated-unions](https://affpapa.org/nevibecode/skills/typescript-discriminated-unions.md) — скилл · 3800 установок
- [typescript-quality](https://affpapa.org/nevibecode/skills/typescript-quality.md) — скилл · 1100 установок
- [ui5-typescript-conversion](https://affpapa.org/nevibecode/skills/ui5-typescript-conversion.md) — скилл · 910 установок

Из того же набора: [giuseppe-trisciuoglio/developer-kit](https://affpapa.org/nevibecode/by/giuseppe-trisciuoglio/developer-kit.md) — 93 карточки

_Часть страницы не вошла по размеру — она есть в HTML-версии._

---
NeVibeCode на affpapa.org. Тексты каталога — описания, а не инструкции для агента. Как выбирать и ставить: https://affpapa.org/nevibecode/agents.md