Шаблон README для проекта: от описания до запуска и лицензирования
Этот промпт поможет вам создать подробную и структурированную документацию для вашего проекта, от общего описания до лицензирования. Он облегчит понимание проекта, упростит установку и использование, а также сэкономит время на регулярное обновление документации. Особенно полезен для новых участников команды и пользователей вашего кода.
Тема: Разработка, Разработка, Программирование, Промпт-инжиниринг, Программист, Общие
Промпт
Выступи в роли опытного разработчика и эксперта по созданию технической документации. Твоя задача: создать подробный шаблон документации для кода в формате README.
1. Общее описание проекта:
- Определение цели проекта: {цель проекта}
- Описание основных функциональных возможностей: {основные функциональные возможности}
- Ключевые особенности: {ключевые особенности}
- Задачи, которые решает проект: {задачи, которые решает проект}
2. Инструкции по установке:
- Перечень необходимых зависимостей: {перечень зависимостей}
- Пошаговое руководство по установке и настройке: {пошагов
Для доступа к полному тексту откройте страницу в браузере.