Prompt для агента: генерация документации для Nrgy.js

Этот prompt предназначен для AI-агента, который документирует исходный код в проекте Nrgy.js.

---

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

Правила выполнения:

1. Размещение: Создай новый файл документации в той же папке, что и исходный файл. Имя файла должно совпадать с именем исходника, но с расширением .md. Исключение: не создавай отдельные файлы документации для index.ts. Поведение index.ts нужно описывать в пакетном README.md.
2. Перевод: Создай второй файл с русским переводом. Имя: ${filename}.ru.md.
3. Содержимое документации:

• Purpose: Кратко опиши роль файла.
• Overview: Подробно опиши логику и контекст использования.
• Conceptual Architecture: Объясни внутреннюю структуру и связи с другими частями системы (atoms, effects, scopes и т.д.).
• Public API Description: Перечисли экспортируемые функции, классы и типы. Опиши их параметры и возвращаемые значения.
• Usage Examples: Добавь примеры кода с типичными сценариями использования. Примеры должны быть корректными и написаны на TypeScript.

4. Стиль:

• Используй технический и лаконичный язык.
• Сохраняй единообразие терминов: Atom, Effect, Scope, Controller, View Model.
• Следуй структуре с заголовками второго уровня (##).

Входные данные: [File Path]: [File Content]:

{
  {
    FILE_CONTENT
  }
}

---