---
name: docs-fix
description: Проверка и создание недостающих файлов документации приложения (README, PLAN, CHANGELOG)
allowed-tools: Read, Write, Edit, Glob, Grep
---

# Быстрое наведение порядка в документации

Проанализируй документацию текущего проекта и создай/обнови недостающие файлы согласно [documentation-guidelines.md](/.claude/docs/documentation-guidelines.md).

## Шаг 1: Определи контекст

1. Найди `package.json` — определи имя и версию проекта
2. Определи тип проекта:
   - `apps/*` — приложение (нужны все файлы)
   - `libs/*` — библиотека (нужен только README.md)

## Шаг 2: Проверь обязательные файлы

### Для приложений (apps/)

| Файл              | Проверить                                                       |
| ----------------- | --------------------------------------------------------------- |
| README.md         | Есть? Содержит таблицу документации? Версия актуальна?          |
| PLAN.md           | Есть? Статус задач актуален?                                    |
| PLAN_COMPLETED.md | Есть? Завершённые фичи перенесены из PLAN.md?                   |
| PLAN_TESTING.md   | Есть? Статистика тестов актуальна?                              |
| CHANGELOG.md      | Есть? Формат Keep a Changelog? Версия совпадает с package.json? |

### Для библиотек (libs/)

| Файл      | Проверить                                  |
| --------- | ------------------------------------------ |
| README.md | Есть? Описание API? Примеры использования? |

## Шаг 3: Создай недостающие файлы

### CHANGELOG.md

```markdown
# Changelog

Формат основан на [Keep a Changelog](https://keepachangelog.com/ru/1.0.0/).

## [Unreleased]

## [X.Y.Z] - YYYY-MM-DD

### Added

- Первый релиз
```

### PLAN_TESTING.md

````markdown
# План тестирования

## Статистика

| Тип  | Количество | Статус      |
| ---- | ---------- | ----------- |
| Unit | 0          | Планируется |
| E2E  | 0          | Планируется |

## Запуск тестов

```bash
nx test <app>
nx e2e <app>-e2e
```
````

## План по фазам

### Фаза 1

- [ ] Базовые тесты

````
### PLAN_COMPLETED.md

```markdown
# Выполненные задачи

Детальное описание всех реализованных фич.

## Версия X.Y.Z

### Реализовано
- Базовая функциональность

---

**Последнее обновление:** YYYY-MM-DD
````

### README.md (для библиотек)

````markdown
# @letar/<lib-name>

<Описание библиотеки>

## Установка

Библиотека уже включена в монорепозиторий.

```typescript
import { ... } from '@letar/<lib-name>'
```
````

## API

### Функция/Компонент

```typescript
// Пример использования
```

## Команды

```bash
nx build <lib>
nx test <lib>
nx lint <lib>
```

---

**Версия:** X.Y.Z

```
## Шаг 4: Синхронизируй версии

- Версия в `package.json` должна совпадать с:
  - Последней записью в `CHANGELOG.md`
  - Версией в `README.md` (если указана)
  - Версией в `PLAN_COMPLETED.md` (если указана)

## Шаг 5: Обнови даты

Добавь/обнови "Последнее обновление: YYYY-MM-DD" в:
- README.md
- PLAN_COMPLETED.md

## После завершения

Выведи отчёт:
```

## Отчёт о документации

**Проект:** <name>
**Версия:** <version>

### Созданные файлы

- [ ] ...

### Обновлённые файлы

- [ ] ...

### Соответствие documentation-guidelines.md

- README.md: ✅/❌
- PLAN.md: ✅/❌
- PLAN_COMPLETED.md: ✅/❌
- PLAN_TESTING.md: ✅/❌
- CHANGELOG.md: ✅/❌

**Общий статус:** X/5 (Y%)

```
```