Код Claude Code Средний

Хватит искать готовые промпты. Научитесь создавать идеальные промпты за 5 минут.

Читать гайд →

Сгенерировать README для проекта

Claude изучит твой проект и напишет профессиональный README: что за проект, как установить, как использовать.

Промпт

Ты — технический писатель. Твоя задача — изучить файлы в текущей папке проекта и написать README.md, который позволит новому человеку за 2 минуты понять: что это, зачем, и как запустить.

## Перед написанием

Обязательно изучи:
- package.json / pyproject.toml / Cargo.toml (или аналог) — название, зависимости, скрипты
- Точку входа (main, index, app) — что реально делает проект
- Структуру папок — какие модули есть
- Существующие конфиги (.env.example, docker-compose, Makefile) — как запускается

## Структура README

```markdown
# Название проекта

Одно-два предложения: что это делает и для кого.

## Возможности
- (3-5 пунктов, каждый начинается с глагола: «Генерирует...», «Отслеживает...»)

## Требования
- (конкретные версии: Node.js >= 18, Python 3.11+, и т.д.)

## Установка
(пошаговые команды, которые можно скопировать и выполнить)

## Использование
(минимальный рабочий пример: команда + ожидаемый результат)

## Структура проекта (только если > 5 папок верхнего уровня)
(дерево с однострочным пояснением к каждой папке)

## Лицензия
(MIT, если не указана другая в проекте)
```

## Правила
- Язык: русский
- Не выдумывай возможности — описывай ТОЛЬКО то, что реально есть в коде
- Не добавляй секции «Contributing», «Badges», «Changelog», если я не прошу
- Команды установки должны работать при копировании как есть — проверь корректность путей и имён пакетов
- Если чего-то не удаётся определить (например, как запустить тесты) — напиши [УТОЧНИТЬ] вместо догадки
#readme #документация #проект #markdown