Руководство по проверяемому и доказательному code summary

  • text-to-text

(от codex-master )

  • text-to-text

Промпт создаёт практическое руководство по написанию надёжного code summary: со структурой, правилами отбора выдержек, контролем качества, Markdown-шаблоном и двумя короткими примерами на основе простой функции.

Подготовь исчерпывающее и воспроизводимое руководство по написанию надёжного `code summary` для технической аудитории. Пиши на русском языке, в Markdown и без лишних вводных рассуждений.

Роль: ты технический писатель и эксперт по обзору кода.

Что такое `code summary` в этом задании:
- одно предложение `TL;DR`;
- краткие ключевые пункты: что делает артефакт, почему важен, какие у него входы, выходы и ограничения;
- подтверждающие выдержки из данных: код, номера строк, выводы тестов, логи или метрики, которые прямо подтверждают утверждения;
- метаданные: охват, автор, дата, версия и контекст использования.

Верни ответ строго в таком порядке:
1. Полное руководство в Markdown
2. Готовый шаблон для заполнения в Markdown
3. Два примера `code summary` на основе одной гипотетической функции поиска максимума в массиве

Обязательные разделы руководства:
1. Краткое введение
2. Структура надёжного `code summary`
3. Правила выбора и представления доказательств
4. Универсальная последовательность действий
5. Требования к содержанию и формулировкам
6. Стиль и форматирование
7. Контроль качества и чек-лист
8. Ограничения и предупреждения

Обязательные детали:
- объём руководства 500-900 слов;
- шаблон не длиннее одной страницы;
- для гипотетического примера сначала приведи 6-8 строк кода функции, затем:
  - короткий summary: 1-2 предложения + одна выдержка;
  - расширенный summary: 5-8 предложений + 2-3 выдержки;
- формат выдержек из кода: `Файл:путь:номер_строки — фрагмент`;
- один блок кода не должен содержать более 10 строк и должен включать только необходимый контекст;
- если используешь логи или тесты, указывай тег, строку или время и кратко объясняй, что именно они подтверждают;
- каждое ключевое утверждение должно иметь явную ссылку на подтверждающую выдержку;
- в шаблоне обязательно включи заголовки:
  - Заголовок
  - TL;DR
  - Что делает
  - Входы / Выходы / Побочные эффекты
  - Ограничения / Предположения
  - Подтверждающие выдержки
  - Метаданные

Ограничения:
- не публикуй чувствительные данные;
- не делай выводов без доказательств;
- не добавляй гипотетические результаты, если они не показаны в примере;
- стиль должен быть прагматичным и проверяемым.

Попробуйте этот промпт

ChatGPT, Claude, GigaChat, Алиса ИИ, По нейросетям, Типы промптов, Яндекс GPT