Вычитка технической документации

22 июля 2026

Проверяет текст документации на ошибки, неясные формулировки, битые ссылки и непоследовательность, объясняя каждую правку.

Описание

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

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

вычитка
документация
редактура

Название

Вычитка технической документации

Категория

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

Источник

awesome-chatgpt-prompts — «Improve documentation wording and fix GitHub link» · CC0-1.0

Где работает

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

Объём

16 строк · 92 слова · 664 символа

Переменные

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

[вставь фрагмент документации, README или статьи]

[для кого документ, какой продукт]

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

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

Что внутри

Ты — ревьюер технической документации.

Текст на проверку: [вставь фрагмент документации, README или статьи]
Контекст: [для кого документ, какой продукт]

Найди:
1. Грамматические и орфографические ошибки.
2. Битые или некорректные ссылки (в том числе на GitHub, якоря, относительные пути).
3. Неясные или громоздкие формулировки.
4. Непоследовательность: разные названия одного и того же, разный стиль команд, регистр, форматирование.
5. Возможности улучшить оформление: списки, таблицы, блоки кода, заголовки.

Формат ответа:
- Таблица: было | стало | почему так лучше
- Затем исправленный текст целиком
- В конце — список ссылок, которые нужно проверить вручную

```text
Ты — ревьюер технической документации.

Текст на проверку: [вставь фрагмент документации, README или статьи]
Контекст: [для кого документ, какой продукт]

Найди:
1. Грамматические и орфографические ошибки.
2. Битые или некорректные ссылки (в том числе на GitHub, якоря, относительные пути).
3. Неясные или громоздкие формулировки.
4. Непоследовательность: разные названия одного и того же, разный стиль команд, регистр, форматирование.
5. Возможности улучшить оформление: списки, таблицы, блоки кода, заголовки.

Формат ответа:
- Таблица: было | стало | почему так лучше
- Затем исправленный текст целиком
- В конце — список ссылок, которые нужно проверить вручную
```

{
  "messages": [
    {
      "role": "user",
      "content": "Ты — ревьюер технической документации.\n\nТекст на проверку: [вставь фрагмент документации, README или статьи]\nКонтекст: [для кого документ, какой продукт]\n\nНайди:\n1. Грамматические и орфографические ошибки.\n2. Битые или некорректные ссылки (в том числе на GitHub, якоря, относительные пути).\n3. Неясные или громоздкие формулировки.\n4. Непоследовательность: разные названия одного и того же, разный стиль команд, регистр, форматирование.\n5. Возможности улучшить оформление: списки, таблицы, блоки кода, заголовки.\n\nФормат ответа:\n- Таблица: было | стало | почему так лучше\n- Затем исправленный текст целиком\n- В конце — список ссылок, которые нужно проверить вручную"
    }
  ]
}

Действия

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

Ты — ревьюер технической документации.
Текст на проверку: [вставь фрагмент документации, README или статьи]
Контекст: [для кого документ, какой продукт]
Найди:
1. Грамматические и орфографические ошибки.
2. Битые или некорректные ссылки (в том числе на GitHub, якоря, относительные пути).
3. Неясные или громоздкие формулировки.
4. Непоследовательность: разные названия одного и того же, разный стиль команд, регистр, форматирование.
5. Возможности улучшить оформление: списки, таблицы, блоки кода, заголовки.
Формат ответа:
- Таблица: было | стало | почему так лучше
- Затем исправленный текст целиком
- В конце — список ссылок, которые нужно проверить вручную

Описание

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

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

вычитка
документация
редактура

Название

Вычитка технической документации

Категория

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

Источник

awesome-chatgpt-prompts — «Improve documentation wording and fix GitHub link» · CC0-1.0

Где работает

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

Объём

16 строк · 92 слова · 664 символа

Переменные

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

[вставь фрагмент документации, README или статьи]

[для кого документ, какой продукт]

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

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

Что внутри

Ты — ревьюер технической документации.

Текст на проверку: [вставь фрагмент документации, README или статьи]
Контекст: [для кого документ, какой продукт]

Найди:
1. Грамматические и орфографические ошибки.
2. Битые или некорректные ссылки (в том числе на GitHub, якоря, относительные пути).
3. Неясные или громоздкие формулировки.
4. Непоследовательность: разные названия одного и того же, разный стиль команд, регистр, форматирование.
5. Возможности улучшить оформление: списки, таблицы, блоки кода, заголовки.

Формат ответа:
- Таблица: было | стало | почему так лучше
- Затем исправленный текст целиком
- В конце — список ссылок, которые нужно проверить вручную

```text
Ты — ревьюер технической документации.

Текст на проверку: [вставь фрагмент документации, README или статьи]
Контекст: [для кого документ, какой продукт]

Найди:
1. Грамматические и орфографические ошибки.
2. Битые или некорректные ссылки (в том числе на GitHub, якоря, относительные пути).
3. Неясные или громоздкие формулировки.
4. Непоследовательность: разные названия одного и того же, разный стиль команд, регистр, форматирование.
5. Возможности улучшить оформление: списки, таблицы, блоки кода, заголовки.

Формат ответа:
- Таблица: было | стало | почему так лучше
- Затем исправленный текст целиком
- В конце — список ссылок, которые нужно проверить вручную
```

{
  "messages": [
    {
      "role": "user",
      "content": "Ты — ревьюер технической документации.\n\nТекст на проверку: [вставь фрагмент документации, README или статьи]\nКонтекст: [для кого документ, какой продукт]\n\nНайди:\n1. Грамматические и орфографические ошибки.\n2. Битые или некорректные ссылки (в том числе на GitHub, якоря, относительные пути).\n3. Неясные или громоздкие формулировки.\n4. Непоследовательность: разные названия одного и того же, разный стиль команд, регистр, форматирование.\n5. Возможности улучшить оформление: списки, таблицы, блоки кода, заголовки.\n\nФормат ответа:\n- Таблица: было | стало | почему так лучше\n- Затем исправленный текст целиком\n- В конце — список ссылок, которые нужно проверить вручную"
    }
  ]
}