---
docgen:
  source: npm/rules/doc-files/js/docgen-prompts.mjs
  crc: 72ac304f
  score: 100
---

# docgen-prompts.mjs

## Огляд

Файл надає інструкції для створення лаконічної поведінкової документації українською мовою. Він містить інструменти для формування, перевірки та виправлення тексту документації, а також для визначення гарантій щодо роботи файлу

## Поведінка

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

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

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

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

- Read-only: файл не виконує операцій запису у файлову систему.
- За невдачі повертає значення помилки (`false`/`null`/`Err`) замість генерування винятку чи паніки.
- Кешує результати в межах одного прогону.
- Не звертається до мережі.
