Не читал документацию — не специалист: гайд, как правильно это делать (для самоучек и не только)

Можно ли стать хорошим специалистом, ни разу не заглянув в документацию? QA Engineer, автор курсов по тестированию и YouTube-блогер Артем Русов на этот вопрос отвечает однозначным «нет».

Специально для Highload Артем рассказывает, чем может помочь документация самоучкам и сеньорам и как правильно ее читать.

Зачем нужно читать документацию

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

Важно! Обычно документация на английском. Именно поэтому айтишнику важно знать язык. Но если уровень низкий, можно поискать локализации или версии от волонтеров. В крайнем случае — пользоваться гугл-переводчиком.

Нельзя стать хорошим специалистом, ни разу не заглянув в документацию. Документация закрывает большое количество вопросов и делает из вас того специалиста, который любит исследование и знает, где найти ответ. Как минимум в первые пару лет в своей работе нужно научиться дружить с документацией как проектной, так и внешней.

К тому же, зачастую только через документацию можно быстро узнать об обновлении и одним из первых начать использовать новые функции приложения.

Зачем документация НЕ новичку

Даже матерый специалист не должен знать документацию назубок. Он должен уметь в ней ориентироваться, чтобы быстро находить то, что ему нужно.

Совет для сеньоров: Справочная информация должна оставаться справочной, поэтому не мучайте ребят на интервью по каждой мельчайшей возможности инструмента. Главное — понимать, для чего он вообще.

Что можно найти в документации

В хорошей документации есть следующая информация:

1. Общее описание инструмента.
2. Вопросы по установке и настройке на разных платформах — как с помощью графического интерфейса, так и командной строки. Кстати, советую разбираться в первую очередь с командной строкой. Она вшита во многие среды разработки, базовые команды любят спрашивать на интервью, да и страх инструмента пропадет.
   

   Source: ProductHunt

3. Базовые позитивные кейсы использования с примерами. Возможно, именно ваша проблема не такая уж сложная и ее уже описали в документации.
4. В некоторых инструментах есть готовые тестовые данные и «песочницы», на которых можно потренироваться. Как раз закроете вопрос с практикой.
5. Иногда документация может быть интерактивной, например, наборы коллекций в Postman, где можно научиться работать руками в инструменте.

Какую документацию читать

Читайте документацию ко всем инструментам, которые используете. Даже у мануального тестировщика их много: от багтрекинговых систем (Jira) до синтаксиса БД и СУБД (MySQL). У автоматизатора и разработчика таких инструментов еще больше: языки программирования, IDE и т.п.

Как правильно читать документацию

Я бы советовал ознакомиться в первую очередь с базой: установка/настройка/запуск. А далее не идти постранично, а отталкиваться от поставленных перед вами задач.

Например, Postman можно использовать для перехвата HTTPs-запросов. Но всем ли надо это знать? Однозначного ответа нет.

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

Но в первую очередь нужно понимать, для чего нужен инструмент, его интерфейс и закрываемый им фронт работ. Не советую сразу использовать все по максимуму: мозг имеет свойство забывать, а документация никуда не пропадет и всегда будет в том же самом месте. Тем более что версии приложений меняются, старые функции обрастают новыми, какие-то уходят в сторонние приложения.

Чем пользоваться помимо документации

• Смотреть бесплатные/платные курсы на Stepik, Udemy, Coursera, PluralSight, YouTube.
• Читать статьи на профессиональных ресурсах вроде Stack Overflow.
• Присоединиться к профессиональным сообществам/чатам в мессенджерах.
• Если вы уже на проекте, то часто сами участники команды пишут проектную документацию и мануалы, где описывают типовые задачи для конкретного продукта, который разрабатывают. Обязательно уточните у вашего ментора, где ее искать.

Важно! Многие думают, что ролики в YouTube смогут заменить самостоятельную проработку документации и ее практическое применение, но это не так. Обычно видеоуроки — про то, что и так лежит на поверхности, а углубляться придется уже самим.