---
docgen:
  source: npm/rules/doc-files/js/docgen-prompts.mjs
  crc: 28c9e818
  model: omlx/gemma-4-e4b-it-OptiQ-4bit
  score: 100
---

# docgen-prompts.mjs

## Огляд

Генерує технічну документацію на основі коду. Створює компоненти документації, такі як огляд (`overviewMessages`), повідомлення для секцій (`sectionMessages`), повідомлення для критики (`criticMessages`), повідомлення для уточнення (`refineMessages`) та гарантії, отримані з маркерів (`guaranteesFromMarkers`), застосовуючи заданий стиль (`STYLE`).

## Поведінка

STYLE: Пише лаконічну поведінкову документацію до коду українською мовою, використовуючи чистий Markdown.
sectionMessages: Генерує набір промптів для різних секцій документації, використовуючи метадані файлу та вміст коду.
overviewMessages: Створює узагальнений огляд файлу, базуючись на вже згенерованій секції «Поведінка».
criticMessages: Перевіряє чорнетку секції на відповідність технічним критеріям, виявляючи дефекти.
refineMessages: Переписує чорнетку секції, виправляючи дефекти, виявлені критиком.
guaranteesFromMarkers: Формує список гарантій поведінки, виходячи з машинно-виведених маркерів файлу.
oneShotMessages: Генерує базовий промпт для генерації повної документації за один виклик.

## Публічний API

STYLE — Визначає загальний стиль та намір файлу.
sectionMessages — Містить мінімально необхідний контекст для кожної секції.
overviewMessages — Генерує узагальнений огляд на основі вже визначеної поведінки.
criticMessages — Виявляє конкретні недоліки у чорновому тексті секції, повертаючи список проблем або відсутність проблем.
refineMessages — Переписує чорновий текст, виправляючи виявлені недоліки.
guaranteesFromMarkers — Створює чіткий шаблон секції «Гарантії поведінки» на основі фактів.
oneShotMessages — Надає приклади для порівняння.

## Гарантії поведінки

- Read-only: не виконує операцій запису (ФС/БД).
- Кешує результати в межах одного прогону.
