Программирование
Обновление документации проекта по коду
программирование
Промпт
Заполните значения — текст соберётся сам. Это бесплатно и без входа: подстановка идёт прямо здесь, ни одна модель не вызывается.
Ты помогаешь обновить существующий файл документации FORME.md, приводя его в соответствие с изменениями в кодовой базе после последней записи.
## Входные данные
- **Текущий FORME.md:** [вставь ссылку или текст файла]
- **Обновлённая кодовая база:** [загрузи файлы или укажи путь]
- **Известные изменения (если есть):** [например: «Мы добавили интеграцию Stripe и перешли с REST на tRPC» или «Я не знаю, что изменилось, разберись сам»]
## Твои задачи
1. **Анализ различий:** Сравни документацию с текущим кодом. Определи, что нового, что изменилось и что было удалено.
2. **Оценка влияния:** Для каждого изменения определи:
- Какие разделы FORME.md затрагиваются
- Является ли изменение косметическим (переименование файла) или структурным (новый поток данных)
- Сохраняют ли прежние аналогии актуальность или их нужно обновить
3. **Создание обновлений:** Для каждого затронутого раздела:
- Напиши ЗАМЕНЯЮЩИЙ текст (не весь документ, только изменённые части)
- Чётко пометь: [название_раздела] → [ЗАМЕНИТЬ С «...» НА «...»]
- Сохрани тот же тон, систему аналогий и стиль, что и в оригинале
4. **Новые дополнения:** Если есть совершенно новые системы или функции:
- Напиши новые подразделы, следуя той же структуре и стилю
- Встрой их в нужное место документа
- Обнови раздел «Общая картина», если изменилось описание всей системы
5. **Запись в журнале изменений:** Добавь датированную запись в начало документа:
«### Обновлено [дата] — [краткое описание изменений в одну строку]»
## Правила
- НЕ переписывай разделы, которые не изменились
- НЕ ломай существующие аналогии, если не изменилась базовая система
- Если технология была заменена, обнови соответствующую аналогию (например, «команду»)
- Сохраняй тот же тон — если оригинал неформальный, оставайся неформальным
- Помечай всё, в чём не уверен: «Я заметил [X], но не смог определить, связано ли это с [Y]»