Документация смарт-контрактов с версионированием и примерами

  • text-to-text

(от codex-master )

  • text-to-text

Промпт готовит Markdown-документацию по смарт-контрактам: описывает функциональность, требования к интеграции, типовые ошибки, формат контроля версий и один сценарий непонимания для целевой аудитории.

Подготовь чёткую техническую документацию по смарт-контрактам для [НАЗВАНИЕ КОМПАНИИ].

Используй вход:
- [НАЗВАНИЕ КОМПАНИИ]
- [СЦЕНАРИИ ИСПОЛЬЗОВАНИЯ]
- [СУЩЕСТВУЮЩИЕ ШАБЛОНЫ]
- [ТРЕБОВАНИЯ СТЕЙКХОЛДЕРОВ]
- [ПРОБЛЕМЫ ПОЛЬЗОВАТЕЛЕЙ]
- [ФОРМАТ КОНТРОЛЯ ВЕРСИЙ]

Если какое-либо поле пустое, сделай минимально необходимое допущение и перечисли его в начале документа. Если допущений нет, напиши `Допущений нет`.

Верни один Markdown-файл на русском языке, используя H2 для основных секций, строго в таком порядке:
1. Заголовок и краткое резюме
2. Функциональность смарт-контрактов
3. Предпосылки и требования для взаимодействия
4. Распространённые ошибки и решения
5. Контроль версий документации
6. Самое слабое допущение и способ проверки
7. Реалистичный сценарий непонимания
8. Приложения
9. Контакты/Ответственные

Что обязательно включить:
- для каждого use case опиши назначение, поведение, ключевые методы, параметры и события;
- в разделе 3 дай checklist интегратора, пример JSON-RPC или ethers.js/web3-вызова и требования к сети, ABI, адресам и правам;
- в разделе 4 перечисли 3-5 проблем по схеме «проблема -> причина -> диагностика -> решение» и приведи минимум 2 примера логов или ошибок;
- в разделе 5 либо используй [ФОРМАТ КОНТРОЛЯ ВЕРСИЙ], либо предложи единый стандарт и шаблон CHANGELOG;
- в разделе 6 назови ровно одно слабое допущение и конкретные шаги его проверки;
- в приложениях добавь короткие примеры вызова функции, CI-конфигурации и записи CHANGELOG, не длиннее 20 строк каждый.

Ограничения:
- общий объём около 1500 слов или меньше;
- не добавляй другие разделы;
- не задавай уточняющих вопросов.

Попробуйте этот промпт

ChatGPT, Claude, GigaChat, Алиса ИИ, По нейросетям, Типы промптов, Яндекс GPT