Почему
| Что теряем со скриншотом | Чем это кончается |
|---|---|
| копирование | команду перепечатывают руками: l вместо 1, O вместо 0, пропущенный пробел |
| поиск | Ctrl+F и поиск по сайту не находят текст ошибки, а по нему материал и ищут |
| телефон | картинка шириной 1600 px на экране 360 px — буквы в 4–5 раз мельче, увеличить можно только всю картинку |
| тёмная тема | белый прямоугольник среди тёмной страницы |
| экранный диктор | читает подпись к картинке, если она есть, — и ничего больше |
| правка | одна изменённая строка — новый скриншот целиком; текст правится в редакторе |
Как подаём код
- Команды и вывод — разными блоками или с пометкой, где что: копируют команду, а не вывод вместе с ней.
- Вывод — точной копией, с настоящими строками ошибок: по ним ищут.
- Длинный конфиг — с пояснениями к строкам, а не стеной на 80 строк.
- Секреты в выводе заменяем на
…до вставки, а не замазываем на картинке.
Когда скриншот правильный
- Где нажать в интерфейсе: панель, настройки, консоль провайдера.
- Как выглядит результат: вёрстка, график, ошибка в браузере.
Скриншот при этом обрезан до нужного места, с пометкой рамкой или стрелкой, без личного (почты, токенов, адресов в строке браузера), и рядом — текст того, ради чего его сняли: подпись кнопки, текст ошибки.