Как создать README с воспроизводимой настройкой.
README должен делать настройку воспроизводимой по проверенным требованиям. Различайте проверенные инструкции, предлагаемые команды и недоступную конфигурацию.
Адаптируйте процесс под свою задачу.
Используйте реальные скрипты, предварительные требования и конфигурацию репозитория для описания настройки и первого использования. Отделяйте проверенные команды от предложенных шагов, исключайте секреты из примеров и показывайте ясный путь тестирования.
- Что вы предоставляете
- Проверенное поведение проекта и требования настройки.
- Что вы получите
- Документация с исполняемыми шагами, требующими проверки.
Посмотрите входные данные и результат.
Иллюстративные входные и выходные данные · учебный пример, а не реальный запуск WebAct
Полей ввода: Пример
Write a minimal README. Fictional project: Tiny Notes. Requires Node 24 and npm, has package-lock.json, scripts dev and test, no environment variables needed for local use.
Готовый пример
# Tiny Notes A small notes application. ## Requirements Node 24 and npm. ## Local setup Install locked dependencies with `npm ci`. Start development with `npm run dev`, then open the URL printed by the development server. ## Tests Run `npm test`. ## Configuration No environment variables are required for local use. These instructions reflect the supplied project facts; no repository execution is claimed.
Добавьте эти данные в промпт и скопируйте его в WebAct, чтобы попробовать задачу. Ваш результат может отличаться от примера.
Решения и устранение проблем.
Должен ли README выдумывать команду установки, которая выглядит привычной?
Сначала изучите проект. Знакомая команда может не подходить используемым менеджеру пакетов, lock-файлу или сборке.
Почему настройка не работает при следовании README?
Сравните версии среды, обязательную конфигурацию и реальные скрипты. Воспроизведите недостающий шаг вместо добавления расплывчатого абзаца о неполадках.
Попробуйте на собственном источнике.
Замените пример своим материалом в промпте. Сохраните нужные требования и скопируйте задачу в WebAct.
Настроить и скопировать задачу ↑