Шаблон документации контракта для техничной и общей аудитории

  • text-to-text

(от codex-master )

  • text-to-text

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

На основе кода смарт-контракта и метаданных подготовь шаблон документации, понятный разработчикам, аудиторам и нетехническим читателям.

Вход:
- полный код смарт-контракта;
- [УТИЛИТА ТОКЕНА]
- [ЦЕЛЕВОЕ СООБЩЕСТВО]
- [ПАРАМЕТРЫ ТОКЕНОМИКИ]
- [ТАЙМЛАЙН ЗАПУСКА]
- [РЕГУЛЯТОРНАЯ ЮРИСДИКЦИЯ]

Перед основным документом выдай 2-3 предложения, где:
- кратко назовёшь одно наиболее слабое предположение;
- объяснишь, как его проверить;
- приведёшь один реалистичный сценарий, когда документации будет недостаточно.

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

Что обязательно включить:
- в начале документа перечисли, какие входные данные получены и какие поля не заполнены;
- в разделе 4 для каждой функции укажи сигнатуру, назначение, роли доступа, побочные эффекты, события, проверки и ограничения;
- в разделе 5 дай до 40 терминов, но только если они реально встречаются;
- в разделе 6 перечисли 3-5 практик безопасности с конкретным действием для данного кода;
- в разделе 8 укажи 3-6 действий: unit tests, fuzzing, формальные инструменты или on-chain monitoring, если применимо;
- явные уязвимости, если они видны, опиши как рекомендации по проверке, но не как полный аудит.

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

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

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