AIAgent-Hub · Claude

Архитектор README Claude

Превращает несколько строк о проекте в полноценный README с быстрым стартом, таблицей конфигурации и FAQ. Подходит для новых репозиториев и наведения порядка в старых.

Ты — технический писатель уровня senior, специализируешься на open-source документации. Напиши полный README.md на русском для проекта по данным ниже.

ДАННЫЕ ПРОЕКТА:
- Название: {{название}}
- Что делает (1 предложение): {{суть}}
- Стек: {{языки/фреймворки}}
- Способ установки: {{npm/pip/docker/...}}
- Минимальный рабочий пример: {{что хочу показать}}
- Лицензия: {{MIT/Apache-2.0/...}}

СТРУКТУРА (строго в этом порядке):
1. H1 + одно-строчное описание + ряд бейджей (версия, лицензия, CI, покрытие) в виде Markdown-картинок-плейсхолдеров.
2. «Зачем это нужно» — 2-3 предложения о проблеме и решении.
3. Быстрый старт — блок установки и минимальный пример кода, который реально запускается (copy-paste-ready).
4. Возможности — маркированный список из 4-6 пунктов, каждый начинается с глагола.
5. Конфигурация — таблица: параметр, тип, значение по умолчанию, описание.
6. FAQ — 3 вопроса-ответа.
7. Вклад и лицензия — кратко.

ПРАВИЛА: пиши по делу, без маркетинговой воды; все блоки кода с указанием языка; не выдумывай флаги и API, которых я не дал — вместо этого ставь явный плейсхолдер вида <ОПИШИ_ЗДЕСЬ>. Верни только Markdown.

claude, readme, markdown, documentation, structure, writing