Learning Platform
Глоссарий Troubleshooting
Урок 07.02 · 15 мин
Начальный
помощьдокументацияпоискновичкам

Где искать помощь

В прошлом уроке мы научились читать ошибки спокойно. Но что делать, когда из ошибки непонятно, как чинить? Или когда ты просто забыл, как работает команда?

Хорошая новость: тебе не нужно держать всё в голове. Даже опытные люди постоянно подсматривают. Разница в том, что они знают, куда смотреть. В этом уроке ты получишь четыре надёжных источника помощи. С ними ты перестанешь застревать и сможешь двигаться сам, не дёргая каждый раз кого-то более опытного.


Самая близкая помощь: флаг —help

Почти у любой команды есть встроенная инструкция. Чтобы её открыть, добавь к команде --help. Это как наклейка на бытовой технике: всё нужное прямо на месте.

ls --help
Usage: ls [OPTION]... [FILE]...
List information about the FILEs (the current directory by default).

  -a, --all      do not ignore entries starting with .
  -l             use a long listing format
  -h, --human-readable  print sizes like 1K 234M 2G
  ...

Не пугайся, что текста много. Тебе не нужно читать всё. Обычно хватает заглянуть в начало (строчка Usage показывает, как вообще запускать команду) и поискать глазами нужный пункт.

TIP

Запомни этот рефлекс: забыл, как работает команда - сначала набери её с --help. Это самый быстрый источник, он не требует интернета и всегда под рукой. У некоторых команд вместо --help работает короткий -h.


man и tldr: справочник и шпаргалка

Если --help мало, есть man (от слова manual - руководство). Это толстый официальный справочник по команде. Открывается так:

man ls

Внутри листаешь стрелками вверх-вниз, а выходишь нажатием буквы q (от quit - выход). Запомни именно q: многие новички “застревают” в man, потому что не знают, как выйти.

Проблема man в том, что он очень подробный и сухой. Для новичка часто слишком много. Поэтому есть прекрасная альтернатива - tldr. Это та же справка, но в виде коротких живых примеров.

tldr tar
tar
Archiving utility.

- Create an archive from files:
  tar cf target.tar file1 file2

- Extract an archive:
  tar xf source.tar

- List the contents of an archive:
  tar tf source.tar

Чувствуешь разницу? man объясняет всё, tldr сразу показывает, как сделать самое частое. Для новичка tldr почти всегда удобнее.

Три уровня встроенной помощи
--helpСамое быстрое. Краткий список опций прямо в терминале. Начинай отсюда.
мало?
tldrГотовые примеры самых частых задач. Понятно новичку. Нужно установить отдельно.
нужнее?
manПолный официальный справочник. Очень подробно. Выход - буква q.
NOTE

tldr обычно не стоит в системе по умолчанию - его нужно установить (как именно, зависит от твоей системы, об установке программ был отдельный модуль). А вот --help и man есть почти везде из коробки.


Официальная документация

Встроенная справка хороша для команд терминала. Но если ты работаешь с целой программой или языком (например, Python), у них есть свой большой сайт с документацией.

Документация - это официальная инструкция от тех, кто эту программу сделал. Это самый надёжный источник: там не бывает устаревших или выдуманных советов, как иногда в случайных блогах. Минус один - читать её поначалу тяжеловато.

TIP

Как быстро найти официальную документацию: набери в поиске название программы и слово “documentation” или “docs”. Например, “python documentation”. Доверяй в первую очередь сайту самого проекта, а не случайным пересказам.


Поиск по тексту ошибки

А теперь самый частый приём в реальной жизни. Когда ты получил непонятную ошибку, скопируй её текст и вставь в поисковик. Скорее всего, ты не первый, кто на неё наткнулся, и кто-то уже разобрался.

Но искать надо с умом. Сравни два запроса:

у меня не работает питон помогите

против:

python ModuleNotFoundError: No such module named requests

Первый запрос - крик о помощи, по нему компьютер ничего конкретного не найдёт. Второй - точный текст ошибки, по нему сразу выпадут готовые решения. Вот как сформулировать хороший запрос:

  1. Скопируй ключевую часть ошибки дословно (само сообщение, а не “всё сломалось”).
  2. Убери из неё личное: свои имена файлов и пути замени на общие, иначе под твой уникальный путь ничего не найдётся.
  3. Добавь контекст: название программы или твоей системы (например, “python” или “macOS”).
WARNING

Не вставляй в публичный поиск свои пароли, ключи и личные данные, даже если они попали в текст ошибки. То, что ты ищешь в интернете, может сохраниться. Перед поиском прочитай, что именно копируешь.


Попробуй сам

Потренируй все четыре источника. Открой терминал и сделай по шагам:

  1. Посмотри встроенную справку у знакомой команды:
mkdir --help
  1. Открой короткие примеры через tldr (если он установлен) и выйди, когда насмотришься:
tldr cp
  1. Открой полный справочник и потренируйся выходить из него по букве q:
man cp
  1. Возьми любую ошибку, которую ты ловил в прошлом уроке (например, “command not found”), и придумай для неё хороший поисковый запрос: дословный текст ошибки плюс слово, обозначающее твою систему. Запиши этот запрос на бумаге - это тренировка навыка формулировать.

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


Проверка знанийKnowledge check
Ты запустил незнакомую команду и получил ошибку, текст которой тебе ничего не говорит. У тебя есть интернет. Опиши по шагам, как из этой ситуации выбраться самому, не зовя никого на помощь, и какой поисковый запрос будет хорошим, а какой плохим.
ОтветAnswer
Сначала стоит заглянуть во встроенную справку самой команды: набрать её с флагом --help, а если этого мало - открыть man по этой команде (выход из man - буква q) или короткие примеры через tldr. Если справка не объясняет именно твою ошибку, скопируй ключевой текст ошибки и вставь его в поисковик. Хороший запрос - это дословное сообщение об ошибке плюс контекст: название программы или системы, например python и сам текст ошибки. Плохой запрос - это расплывчатое "у меня не работает, помогите", по нему ничего конкретного не найдётся. Перед поиском важно убрать из текста личное: свои имена файлов и пути заменить на общие, и ни в коем случае не вставлять пароли или ключи. Так ты почти всегда найдёшь, что кто-то уже решил такую же проблему.

Проверьте понимание

Результат: 0 из 0
Прикладной
Вопрос 1 из 3. Ты забыл, как работает команда, и хочешь быстро глянуть подсказку прямо в терминале, без интернета. С чего разумнее всего начать?

Закончили урок?

Отметьте его как пройденный, чтобы отслеживать свой прогресс

Войдите чтобы оценить урок

Прогресс модуля
0 из 3