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

12 июня 2026

Смотрит на diff и определяет, что обновить в README, API-доках, конфиге и CHANGELOG, затем выдаёт готовые правки.

Описание

ДокументацияБесплатно

Замените фрагменты в квадратных скобках своими данными и вставьте промпт в чат с ИИ.

README
CHANGELOG
diff
документация

Название

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

Категория

Документация

Источник

awesome-copilot — update-docs-on-code-change.instructions.md · MIT

Где работает

ChatGPT, Claude и другие ИИ-ассистенты

Объём

29 строк · 188 слов · 1 305 символов

Переменные

Значения сразу появятся в превью, коде и при копировании.

[вставь diff или список изменений]

[README.md, docs/, CHANGELOG.md — вставь или укажи пути]

Как использовать

1Заполните поля выше или замените фрагменты в квадратных скобках вручную.
2Скопируйте промпт — он попадёт в буфер обмена целиком.
3Вставьте его в чат с ИИ: ChatGPT, Claude или любой другой ассистент.
4Уточняйте ответ короткими репликами, не переписывая промпт заново.

Что внутри

Ты — инженер, который следит, чтобы документация не отставала от кода.

Вводные:
- Diff или описание изменений: [вставь diff или список изменений]
- Текущие документы: [README.md, docs/, CHANGELOG.md — вставь или укажи пути]

Шаг 1. Определи, нужны ли обновления. Триггеры:
- новая функциональность;
- изменились API, методы или интерфейсы;
- breaking changes;
- поменялись зависимости или требования к окружению;
- новые или изменённые настройки и переменные окружения;
- изменился процесс установки или запуска;
- обновились CLI-команды или скрипты;
- примеры кода в документации устарели.

Шаг 2. Правила обновления:
- README: новые функции в раздел возможностей с примером, изменения установки в «Быстрый старт», актуальное оглавление.
- API-доки: новые и изменённые эндпоинты, параметры, примеры запросов и ответов, коды ошибок.
- Конфигурация: таблица переменных с описанием, значением по умолчанию и обязательностью.
- Breaking changes: гайд по миграции «было → стало».
- CHANGELOG: запись в формате Keep a Changelog (Added / Changed / Fixed / Removed).

Шаг 3. Проверь, что примеры кода соответствуют новой сигнатуре, а ссылки не сломаны.

Формат ответа:
1. Список документов, которые нужно обновить, и причина
2. Готовые правки для каждого файла (блоки Markdown)
3. Что осталось проверить вручную

```text
Ты — инженер, который следит, чтобы документация не отставала от кода.

Вводные:
- Diff или описание изменений: [вставь diff или список изменений]
- Текущие документы: [README.md, docs/, CHANGELOG.md — вставь или укажи пути]

Шаг 1. Определи, нужны ли обновления. Триггеры:
- новая функциональность;
- изменились API, методы или интерфейсы;
- breaking changes;
- поменялись зависимости или требования к окружению;
- новые или изменённые настройки и переменные окружения;
- изменился процесс установки или запуска;
- обновились CLI-команды или скрипты;
- примеры кода в документации устарели.

Шаг 2. Правила обновления:
- README: новые функции в раздел возможностей с примером, изменения установки в «Быстрый старт», актуальное оглавление.
- API-доки: новые и изменённые эндпоинты, параметры, примеры запросов и ответов, коды ошибок.
- Конфигурация: таблица переменных с описанием, значением по умолчанию и обязательностью.
- Breaking changes: гайд по миграции «было → стало».
- CHANGELOG: запись в формате Keep a Changelog (Added / Changed / Fixed / Removed).

Шаг 3. Проверь, что примеры кода соответствуют новой сигнатуре, а ссылки не сломаны.

Формат ответа:
1. Список документов, которые нужно обновить, и причина
2. Готовые правки для каждого файла (блоки Markdown)
3. Что осталось проверить вручную
```

{
  "messages": [
    {
      "role": "user",
      "content": "Ты — инженер, который следит, чтобы документация не отставала от кода.\n\nВводные:\n- Diff или описание изменений: [вставь diff или список изменений]\n- Текущие документы: [README.md, docs/, CHANGELOG.md — вставь или укажи пути]\n\nШаг 1. Определи, нужны ли обновления. Триггеры:\n- новая функциональность;\n- изменились API, методы или интерфейсы;\n- breaking changes;\n- поменялись зависимости или требования к окружению;\n- новые или изменённые настройки и переменные окружения;\n- изменился процесс установки или запуска;\n- обновились CLI-команды или скрипты;\n- примеры кода в документации устарели.\n\nШаг 2. Правила обновления:\n- README: новые функции в раздел возможностей с примером, изменения установки в «Быстрый старт», актуальное оглавление.\n- API-доки: новые и изменённые эндпоинты, параметры, примеры запросов и ответов, коды ошибок.\n- Конфигурация: таблица переменных с описанием, значением по умолчанию и обязательностью.\n- Breaking changes: гайд по миграции «было → стало».\n- CHANGELOG: запись в формате Keep a Changelog (Added / Changed / Fixed / Removed).\n\nШаг 3. Проверь, что примеры кода соответствуют новой сигнатуре, а ссылки не сломаны.\n\nФормат ответа:\n1. Список документов, которые нужно обновить, и причина\n2. Готовые правки для каждого файла (блоки Markdown)\n3. Что осталось проверить вручную"
    }
  ]
}

Действия

prompt.txt· заполнено 0 из 2

Ты — инженер, который следит, чтобы документация не отставала от кода.
Вводные:
- Diff или описание изменений: [вставь diff или список изменений]
- Текущие документы: [README.md, docs/, CHANGELOG.md — вставь или укажи пути]
Шаг 1. Определи, нужны ли обновления. Триггеры:
- новая функциональность;
- изменились API, методы или интерфейсы;
- breaking changes;
- поменялись зависимости или требования к окружению;
- новые или изменённые настройки и переменные окружения;
- изменился процесс установки или запуска;
- обновились CLI-команды или скрипты;
- примеры кода в документации устарели.
Шаг 2. Правила обновления:
- README: новые функции в раздел возможностей с примером, изменения установки в «Быстрый старт», актуальное оглавление.
- API-доки: новые и изменённые эндпоинты, параметры, примеры запросов и ответов, коды ошибок.
- Конфигурация: таблица переменных с описанием, значением по умолчанию и обязательностью.
- Breaking changes: гайд по миграции «было → стало».
- CHANGELOG: запись в формате Keep a Changelog (Added / Changed / Fixed / Removed).
Шаг 3. Проверь, что примеры кода соответствуют новой сигнатуре, а ссылки не сломаны.
Формат ответа:
1. Список документов, которые нужно обновить, и причина
2. Готовые правки для каждого файла (блоки Markdown)
3. Что осталось проверить вручную

Описание

ДокументацияБесплатно

Замените фрагменты в квадратных скобках своими данными и вставьте промпт в чат с ИИ.

README
CHANGELOG
diff
документация

Название

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

Категория

Документация

Источник

awesome-copilot — update-docs-on-code-change.instructions.md · MIT

Где работает

ChatGPT, Claude и другие ИИ-ассистенты

Объём

29 строк · 188 слов · 1 305 символов

Переменные

Значения сразу появятся в превью, коде и при копировании.

[вставь diff или список изменений]

[README.md, docs/, CHANGELOG.md — вставь или укажи пути]

Как использовать

1Заполните поля выше или замените фрагменты в квадратных скобках вручную.
2Скопируйте промпт — он попадёт в буфер обмена целиком.
3Вставьте его в чат с ИИ: ChatGPT, Claude или любой другой ассистент.
4Уточняйте ответ короткими репликами, не переписывая промпт заново.

Что внутри

Ты — инженер, который следит, чтобы документация не отставала от кода.

Вводные:
- Diff или описание изменений: [вставь diff или список изменений]
- Текущие документы: [README.md, docs/, CHANGELOG.md — вставь или укажи пути]

Шаг 1. Определи, нужны ли обновления. Триггеры:
- новая функциональность;
- изменились API, методы или интерфейсы;
- breaking changes;
- поменялись зависимости или требования к окружению;
- новые или изменённые настройки и переменные окружения;
- изменился процесс установки или запуска;
- обновились CLI-команды или скрипты;
- примеры кода в документации устарели.

Шаг 2. Правила обновления:
- README: новые функции в раздел возможностей с примером, изменения установки в «Быстрый старт», актуальное оглавление.
- API-доки: новые и изменённые эндпоинты, параметры, примеры запросов и ответов, коды ошибок.
- Конфигурация: таблица переменных с описанием, значением по умолчанию и обязательностью.
- Breaking changes: гайд по миграции «было → стало».
- CHANGELOG: запись в формате Keep a Changelog (Added / Changed / Fixed / Removed).

Шаг 3. Проверь, что примеры кода соответствуют новой сигнатуре, а ссылки не сломаны.

Формат ответа:
1. Список документов, которые нужно обновить, и причина
2. Готовые правки для каждого файла (блоки Markdown)
3. Что осталось проверить вручную

```text
Ты — инженер, который следит, чтобы документация не отставала от кода.

Вводные:
- Diff или описание изменений: [вставь diff или список изменений]
- Текущие документы: [README.md, docs/, CHANGELOG.md — вставь или укажи пути]

Шаг 1. Определи, нужны ли обновления. Триггеры:
- новая функциональность;
- изменились API, методы или интерфейсы;
- breaking changes;
- поменялись зависимости или требования к окружению;
- новые или изменённые настройки и переменные окружения;
- изменился процесс установки или запуска;
- обновились CLI-команды или скрипты;
- примеры кода в документации устарели.

Шаг 2. Правила обновления:
- README: новые функции в раздел возможностей с примером, изменения установки в «Быстрый старт», актуальное оглавление.
- API-доки: новые и изменённые эндпоинты, параметры, примеры запросов и ответов, коды ошибок.
- Конфигурация: таблица переменных с описанием, значением по умолчанию и обязательностью.
- Breaking changes: гайд по миграции «было → стало».
- CHANGELOG: запись в формате Keep a Changelog (Added / Changed / Fixed / Removed).

Шаг 3. Проверь, что примеры кода соответствуют новой сигнатуре, а ссылки не сломаны.

Формат ответа:
1. Список документов, которые нужно обновить, и причина
2. Готовые правки для каждого файла (блоки Markdown)
3. Что осталось проверить вручную
```

{
  "messages": [
    {
      "role": "user",
      "content": "Ты — инженер, который следит, чтобы документация не отставала от кода.\n\nВводные:\n- Diff или описание изменений: [вставь diff или список изменений]\n- Текущие документы: [README.md, docs/, CHANGELOG.md — вставь или укажи пути]\n\nШаг 1. Определи, нужны ли обновления. Триггеры:\n- новая функциональность;\n- изменились API, методы или интерфейсы;\n- breaking changes;\n- поменялись зависимости или требования к окружению;\n- новые или изменённые настройки и переменные окружения;\n- изменился процесс установки или запуска;\n- обновились CLI-команды или скрипты;\n- примеры кода в документации устарели.\n\nШаг 2. Правила обновления:\n- README: новые функции в раздел возможностей с примером, изменения установки в «Быстрый старт», актуальное оглавление.\n- API-доки: новые и изменённые эндпоинты, параметры, примеры запросов и ответов, коды ошибок.\n- Конфигурация: таблица переменных с описанием, значением по умолчанию и обязательностью.\n- Breaking changes: гайд по миграции «было → стало».\n- CHANGELOG: запись в формате Keep a Changelog (Added / Changed / Fixed / Removed).\n\nШаг 3. Проверь, что примеры кода соответствуют новой сигнатуре, а ссылки не сломаны.\n\nФормат ответа:\n1. Список документов, которые нужно обновить, и причина\n2. Готовые правки для каждого файла (блоки Markdown)\n3. Что осталось проверить вручную"
    }
  ]
}