Промпт создаёт Markdown-фреймворк документации по кодовой базе смарт-контрактов: компоненты, user stories, TOC, диаграммы, примеры вызовов, security-инструменты и одно ключевое допущение.
В этом промпте 25 строк и 1345 символов
Создай единый Markdown-документ документации по входам:
- [CODEBASE]
- [FUNCTIONALITIES_LIST]
- [TOKEN_UTILITY]
- [TARGET_COMMUNITY]
- [TOKENOMICS_PARAMETERS]
Не задавай вопросов и не предлагай альтернативные версии. Результат выдай строго по разделам A-G:
A. Краткая сводка.
B. Ключевые компоненты кодовой базы.
C. Предполагаемые случаи использования и пользовательские возможности.
D. Подробная структура документации.
E. Диаграммы и блок-схемы.
F. Примеры использования нескольких функций.
G. Самое слабое предположение и сценарий заблуждения.
Что обязательно включить:
- для каждого компонента: путь, ответственность, публичные функции, storage/events, роли доступа, особые характеристики, риски безопасности и нужные тесты;
- для каждого use case: краткое описание, user story и минимальную последовательность вызовов;
- в TOC обязательные блоки Quick Start, User Guide, Developer Guide, Security, Audit Info, Tests & CI, Tokenomics, Upgrades, FAQ;
- 2-4 диаграммы с типом, сущностями и уровнем детализации;
- 3-6 примеров функций с сигнатурой, примером транзакции, ожидаемыми событиями и CLI или ethers.js шагами;
- конкретные security-инструменты и команды: Slither, Echidna, Foundry, Hardhat или релевантные аналоги.
Сохраняй технический тон, указывай точные файлы и команды там, где возможно, и не добавляй мета-комментариев вне A-G.
Промпт доступен бесплатно после регистрации/авторизации
Регистрация
ChatGPT, Claude, GigaChat, Алиса ИИ, По нейросетям, Типы промптов, Яндекс GPT
* Организация Meta Platforms Inc., а также ее продукты Instagram и Facebook, на которые мы ссылаемся в этом промпте, признаны экстремистскими на территории РФ.
