Кому нужен этот промт и как он работает?
Этот промт предназначен для специалистов, которые разрабатывают новые функции программного обеспечения: аналитиков, продуктовых менеджеров, технических писателей и разработчиков. Он помогает быстро составить полный документ требований, включая описание объема проекта, цели, этапы работы, пользовательские истории и тест-кейсы. Также промт задает структуру понятной API-документации.
Использование такого промта помогает сэкономить время и избежать ошибок, связанные с неполным или неструктурированным описанием задач. Он облегчает коммуникацию внутри команды и с конечными пользователями за счет четкой и простой документации.
Принцип работы промта основан на том, что нейросеть получает инструкцию составить развернутое техническое описание новой функции с учетом всех необходимый компонентов, нужных для полного цикла разработки и тестирования.
Готовый промт для использования
|
1 |
Представьте, что вам поручено разработать новую функцию программного обеспечения, которая изменит всю индустрию. Ваша задача — составить подробный документ требований к программному обеспечению, включающий описание объема проекта, целей и этапов выполнения. Также создайте пользовательские истории, отражающие потребности целевой аудитории, и напишите тест-кейсы, которые тщательно проверят функциональность функции. Документация API должна быть ясной, краткой и понятной, чтобы и разработчики, и конечные пользователи могли легко её использовать. Ваша цель — предоставить высококачественную функцию, превосходящую ожидания и приносящую исключительную пользу пользователям. |
Как использовать промт и на что обращать внимание
Рекомендуется четко указывать характер и назначение функции, которую нужно описать, чтобы нейросеть могла создать максимально релевантный документ.
Следует при необходимости разбивать промт на части, если документ слишком большой — например, сначала формулировать требования, затем создавать пользовательские истории и, наконец, тест-кейсы и документацию API.
- Указывайте целевую аудиторию и контекст использования, чтобы пользовательские истории были релевантны.
- Проверяйте сформированный документ на полноту и логику, корректируйте в случае неточностей.
- Учтите, что генерация больших текстов может занять время и иногда приводить к пропущенным деталям — лучше делать это поэтапно.
- Для более понятной документации API полезно указать формат ответа и примеры использования.
Ограничения: промт само по себе не гарантирует идеальный технический документ без дополнительного редактирования и уточнений со стороны специалиста. Результат может быть поверхностным при слишком общей формулировке задания.
Примеры использования
Первый пример решает задачу описания требований для функции онлайн-платежей, чтобы разработать понятную и точную документацию для команды и тестировщиков.
|
1 |
Представьте, что вам поручено разработать новую функцию программного обеспечения — модуль онлайн-платежей. Составьте подробный документ требований, включающий описание объема проекта, цели (обеспечить безопасные и быстрые платежи), этапы выполнения. Создайте пользовательские истории для клиентов и администраторов, а также тест-кейсы для проверки корректности работы функции. Напишите понятную API-документацию с примерами вызовов и ответов. |
Второй пример демонстрирует использование промта для создания требований к системе автоматизации заказа в ресторане, включая описания ожиданий и тестовые сценарии для проверки.
|
1 |
Представьте, что вам поручено разработать новую функцию программного обеспечения — систему автоматизации заказов в ресторане. Составьте полный документ требований с описанием объема и ключевых целей — снизить время обработки заказов и повысить точность. Создайте пользовательские истории для официантов и кухни, опишите этапы разработки. Напишите тест-кейсы и понятную API-документацию для взаимодействия с мобильным приложением. |
Пример вывода нейросети по промту
Документ требований к функции «Модуль онлайн-платежей»
Описание проекта: Разработка модуля онлайн-платежей для мобильного приложения, который обеспечит пользователям быстрый, удобный и безопасный способ оплаты товаров и услуг.
Цели проекта: Создать надежный платежный механизм, интегрируемый с основными платежными системами, обеспечить соответствие стандартам безопасности и простоту использования.
Этапы разработки: Анализ требований → Проектирование архитектуры → Разработка → Тестирование → Внедрение → Поддержка.
Пользовательские истории: «Как пользователь, я хочу безопасно оплачивать покупки, чтобы быть уверенным в надежности сервиса», «Как администратор, я хочу отслеживать транзакции для аналитики и отчетности».
Тест-кейсы: Проверка успешной оплаты, отмены платежа, обработки ошибок сети, соответствия параметров безопасности.
Документация API: Описывает endpoint для создания платежа, параметры запроса (сумма, валюта, метод оплаты), формат ответа с кодом состояния и деталями транзакции. Образцы вызовов на REST и JSON.
Итог: зачем использовать этот промт?
Этот промт позволяет быстро и качественно сформировать техническую документацию для новых функций программного обеспечения. Он помогает систематизировать требования, учесть потребности пользователей и обеспечить высокое качество продукта с минимальными затратами времени. Использование промта значительно упрощает коммуникацию между разработчиками, аналитиками и тестировщиками.
Главное преимущество: быстрое создание подробных и понятных требований, пользовательских историй, тест-кейсов и API-документации для эффективной разработки ПО.
