imnotreadingal.lat

Я не буду читать всё это

пожалуйста, не присылайте стену текста

Представьте: вы просите о помощи, а потом отправляете роман, где настоящий вопрос спрятан где-то посередине.

Длинный контекст иногда полезен. Огромное неструктурированное сообщение обычно нет. Читатель должен быстро понять просьбу и решить, как помочь, а не сначала выполнять за вас работу редактора.

x Не надо так

Сегодня 14:15

в общем приложение сломалось, я вчера перепробовал кучу всего, там была какая-то штука со страницей auth, может это API, но в документации написано другое, я поменял конфиг потому что деплой был странный, потом подумал что может кэш и...

В чём конкретно проблема?

Так вы заставляете читателя самому искать проблему, просьбу и полезные детали.

ok Лучше так

Сегодня 14:15

Логин возвращает 401 после обновления токена. Ожидаю новую сессию.

Пробовал очистить кэш и переустановить пакеты. Ниже маршрут, ошибка и шаги воспроизведения.

Отлично. Пришли лог.

Теперь читатель знает, что сломалось, что должно произойти и куда смотреть дальше.

Почему это важно

Стена текста требует усилий ещё до того, как человек понял, может ли помочь. Главное теряется среди предыстории, мыслей в сторону и догадок.

Хотите полезный ответ — сначала сделайте полезным своё сообщение. Назовите проблему, приложите доказательства, а длинные детали оставьте ниже краткого резюме.

Формат получше

Проблема: Что сломано?

Ожидание: Что должно произойти?

Пробовал: Что уже проверено?

Детали: Логи, скриншоты, ссылки или примеры.

Сначала резюме. Длинное — после него. Детали читают охотнее, когда понятно, зачем они нужны.