Технический писатель: недооценённый вход в IT

Чем занимается

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

Задача не в том, чтобы красиво написать. В том, чтобы человек прочитал и смог сделать. Хорошая документация проверяется просто: получилось ли у читателя.

Почему это недооценённый вход

Порог по программированию низкий. Нужно понимать, о чём пишете, но не нужно уметь это писать самому.

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

Гуманитарное образование здесь плюс, а не минус. Умение внятно излагать — редкий навык, и он в основе профессии.

Вход в отрасль состоялся. Дальше можно двигаться в аналитику, управление продуктом, тестирование — вы уже внутри и понимаете, как всё устроено.

Что нужно знать

Писать понятно. Основа. Короткие предложения, активный залог, конкретика вместо общих слов, логичный порядок.

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

Работать с разметкой. Простые языки разметки текста, из которых собирается документация.

Системы контроля версий. Документация в современных компаниях живёт рядом с кодом и обновляется так же.

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

Английский на чтение. Значительная часть первоисточников на нём. Для многих вакансий требуется и письменный.

Что отличает хорошего писателя

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

Пишет для конкретного читателя. Инструкция для новичка и справка для опытного — разные тексты, и смешивать их нельзя.

Не боится задавать глупые вопросы. Если писателю непонятно, читателю тем более. Вопрос «а откуда взять этот ключ?» часто вскрывает дыру в продукте.

Как собрать портфолио

Это профессия, где портфолио собирается легче всего: нужен только текст.

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

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

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

Сделайте описание интерфейса для чужого сервиса. Разберитесь, как он работает, и опишите.

Три-четыре такие работы — уже основательная заявка.

Что усиливает

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

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