Главная / Генерация текста / Обновление документации FORME.md

Обновление документации FORME.md

Описание промпта

Инструмент для синхронизации документации FORME.md с изменениями в кодовой базе. Анализирует диффы, оценивает влияние изменений и генерирует точечные обновления с сохранением стиля и аналогий.

Что делает этот промпт

Автоматизирует процесс обновления технической документации FORME.md на основе изменений в коде. Выявляет расхождения, оценивает их влияние и генерирует точечные правки.

Преимущества

Экономит время на рутинном обновлении документации. Сохраняет консистентность стиля и системы аналогий. Снижает риск ошибок при ручном редактировании.

Для кого подходит

Разработчики, технические писатели, лиды команд, поддерживающие документацию в актуальном состоянии.

Инструкция по использованию промпта

1. Загрузи текущий FORME.md и код. 2. Укажи известные изменения. 3. Запусти промпт. 4. Проверь сгенерированные замены. 5. Примени изменения к документу.

Что нужно предоставить

Доступ к текущей версии FORME.md, доступ к обновленной кодовой базе, понимание контекста изменений.

Что ожидать в результате

Обновленные фрагменты текста для вставки в FORME.md, маркированные по разделам, и запись в changelog.

Рекомендации

Убедись, что система аналогий в оригинале понятна. Если изменения критичны, проверь вывод вручную.

Ограничения

Не может автоматически применить изменения к файлу. Требует ручной проверки корректности аналогий и технических деталей.

Переменные

CURRENT_FORME_MD

Обязательная

Содержимое текущего файла FORME.md

UPDATED_CODEBASE

Обязательная

Доступ к обновленной кодовой базе или путь к ней

KNOWN_CHANGES

Необязательная

Список известных изменений (опционально)

DATE

Обязательная

Дата обновления в формате YYYY-MM-DD

Промпт открыт для всех. Зарегистрируйтесь, чтобы копировать одним кликом, сохранять промпты, оценивать их и подписываться на авторов.

Текст промпта

ChatGPT / Claude / Llama Войти для копирования

Ты — эксперт по технической документации. Твоя задача — обновить существующий файл FORME.md, чтобы он отражал изменения в кодовой базе.

## Вводные данные
- **Текущий FORME.md:** {{CURRENT_FORME_MD}}
- **Обновленная кодовая база:** {{UPDATED_CODEBASE}}
- **Известные изменения:** {{KNOWN_CHANGES}}

## Твои задачи

1. **Анализ диффов:** Сравни документацию с текущим кодом. Выяви новое, измененное и удаленное.

2. **Оценка влияния:** Для каждого изменения определи:
- Какие разделы FORME.md затронуты
- Является ли изменение косметическим (переименование) или структурным (новый поток данных)
- Сохраняются ли существующие аналогии или их нужно обновить

3. **Генерация обновлений:** Для каждого затронутого раздела:
- Напиши ЗАМЕНЯЮЩИЙ текст (не весь документ, только измененные части)
- Четко маркируй: {{section_name}} → [REPLACE FROM "..." TO "..."]
- Сохраняй тон, систему аналогий и стиль оригинала

4. **Новые разделы:** Если появились новые системы/функции:
- Напиши новые подразделы, следуя той же структуре и голосу
- Интегрируй их в нужное место документа
- Обнови раздел "Big Picture", если изменилось описание системы

5. **Запись в changelog:** Добавь в начало документа запись:
"### Updated {{DATE}} — [краткое описание изменений]"

## Правила
- НЕ переписывай разделы, которые не изменились
- НЕ ломай существующие аналогии, если не изменилась базовая система
- Если технология заменена, обнови «экипаж» (или эквивалентную аналогию)
- Сохраняй тот же голос: если оригинал неформальный, оставайся неформальным
- Отмечай неопределенности: «Я заметил [X], но не смог определить, [Y]»

Обновление документации FORME.md

Поделитесь в социальных сетях

Комментарии