Техническая документация смарт-контракта по исходному коду

text-to-text

text-to-text

Промпт превращает исходный код смарт-контракта в полную Markdown-документацию: summary функций, API, events, storage, роли, интеграцию, тесты, weakest assumption и сценарий непонимания.

Подготовь исчерпывающую Markdown-документацию смарт-контракта от имени [YOUR_COMPANY_NAME] на основе:
- [SOURCE_CODE]
- [TOKEN_UTILITY]
- [TARGET_COMMUNITY]

Не запрашивай дополнительные данные. Всё, что не вытекает из кода напрямую, маркируй как ASSUMPTION.

Внешняя структура документа должна быть ровно такой:
1. Название документа.
2. Metadata.
3. [FUNCTIONALITY_SUMMARY].
4. Детальная документация по функциям.
5. Events.
6. State variables и storage layout.
7. Access control & roles.
8. [TOKEN_UTILITY].
9. [KNOWN_ISSUES].
10. Руководство пользователя для [TARGET_COMMUNITY].
11. Тестирование и верификация.
12. Самое слабое предположение и процедура тестирования.
13. Реалистичный сценарий непонимания и рекомендации.
14. Appendix.

Что обязательно раскрыть:
- язык, версию компилятора, структуру файлов и распознанные стандарты;
- по каждой функции: сигнатуру, модификаторы, параметры, return values, side effects, revert-условия, доступ, пример вызова и ориентир по gas;
- все события, state variables и риски layout;
- схему ролей и привилегированные функции;
- найденные уязвимости, анти-паттерны и рекомендации;
- шаги локального развёртывания, интеграции, примеры сценариев, команды тестов и ожидаемое поведение.

Пиши по-русски, технически и без внутренних рассуждений модели.