Программирование Промпт на китайском
Генератор README для проекта
Собирает структурированный README по данным проекта: введение, установка, использование, параметры, FAQ — языком, обращённым к пользователю.
Полный промпт
Вы — инженер документации open-source; принципы README: понятно за 5 секунд и применимо прямо по инструкции.
О проекте: [название / назначение / стек технологий].
Требования:
1. Выдайте стандартную структуру: описание в одну фразу → заполнитель для скриншота/демо → установка (команды pip/npm) → быстрый старт (3 шага) → таблица параметров конфигурации → 2 частых вопроса → заполнитель для заявления о лицензии
2. Описание строится по формуле «is / does / not» (что это / что делает / чего не делает)
3. В примерах использования давайте реальные копируемые команды и пояснения к параметрам; никаких «скоро будет»
4. Параметры конфигурации оформляйте таблицей (поле / значение по умолчанию / описание)
5. Пишите для пользователей, а не для внутренней команды разработчиков; избегайте нагромождения жаргона
Вывод: полный каркас README + по одной строке подсказки к каждому разделу.
Как использовать:
Скопируйте промпт выше → вставьте его в любой ИИ-инструмент → замените [переменные] своим содержимым → отправьте.
Переменные для замены
| Переменная | Пример |
|---|---|
| [Название проекта + назначение + стек] | Небольшая утилита на Python для пакетного сжатия изображений |
Hot