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

Чи можна стати хорошим фахівцем, жодного разу не зазирнувши в документацію? 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 зможуть замінити самостійне опрацювання документації та її практичне застосування, але це не так. Зазвичай відеоуроки — про те, що й так лежить на поверхні, а заглиблюватись доведеться вже самим.