Как сделать портфолио инженера

Обновлено: 04.07.2024

Текст Нины Ереминой

Технический писатель — это необязательно full-time должность, вы можете совмещать эту работу с другими задачами. Например, быть разработчиком, переводчиком, аналитиком или дизайнером и выполнять роль технического писателя.

Что делает технический писатель?

Технический писатель (или техрайтер) отвечает за техническую коммуникацию и создаёт документацию продукта на понятном целевой аудитории языке. Целевой аудиторией может быть пользователь вашего приложения, сотрудник службы техподдержки или даже разработчик. Если документацию читают пользователи, то она называется внешней, а если пишется для коллег — внутренней.

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

Создание документации

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

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

Его делают для системных администраторов служб поддержки и других технических специалистов. Такая документация будет описывать не как продуктом пользоваться, а как его настраивать, например, как настроить серверную часть программы или сделать бэкап. Чтобы писать такую документацию, нужно очень хорошо разбираться в продукте, потому что придётся писать то, чего не знает даже техподдержка.

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

Это длинные тексты, которые дают полное описание продукта или функционала. Например, у многих компаний описывается стандарт обработки данных GDPR, как он применяется в конкретной компании. В такой документации обычно много информации, есть графики и схемы.

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

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

Техническая коммуникация

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

Например, если в пользовательской документации вы называете админку Admin dashboard, то она не должна внезапно стать Admin panel в одной из статей. Чтобы сохранить единство терминологии и стандартов, технический писатель разрабатывает внутреннюю базу знаний, где всё это прописано, и может обучать новых сотрудников компании.

Смежные области

В зависимости от задач, с которыми вы сталкивались как технический писатель, есть разные карьерные траектории. В рамках вертикального роста вы можете расти как технический писатель и постепенно вырасти из джуниора в руководителя отдела документирования, или Document Product Owner. Обычно в компаниях есть документ, где прописано, какими навыками надо обладать, и какие обязанности выполняет сотрудник на этой должности. В нём можно посмотреть, что нужно доучить, чтобы перейти на следующий уровень. Такая же система работает для разработчиков, когда с повышением навыков растёт грейд.

Ещё можно приобрести экспертизу в смежных областях, например, можно стать:

UX-писателем — он помогает улучшить тексты в интерфейсе продукта или приложения;
инженером по документированию (DocOps) — он поддерживает процессы автоматизации документации и переводов;
инженером по локализации — он занимается техническим переводом;
техническим евангелистом (специалистом по Developer Relations) — он скорее технический маркетолог, и продвигает технические решения среди коллег или на рынке. Главное отличие евангелиста от маркетолога — знание всех технических аспектов продукта, и чаще всего технический бэкграунд.

Что нужно знать? Инструменты технического писателя

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

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

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

Вам пригодятся навыки определения целевой аудитории и написания текстов с учётом особенностей ЦА, понимание пользы и болей читателя.

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

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

Профессиональные текстовые редакторы

Инструменты, которыми пользуется технический писатель, зависят от задач и степени сложности. Начинать писать документацию можно и в Google Docs, но с увеличением количества связей и уровней будет сложно её поддерживать. Тогда на помощь приходят профессиональные редакторы для технических писателей: MadCap Flare или Confluence.

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

Руководства по стилю — это сборники правил, они помогают соблюсти требования к оформлению, принятые в определённой среде или типе документов. В них можно проверить правила пунктуации, выбора слов и форматирования. Например, Chicago Manual of Style чаще всего используют для написания работ, связанных с историей и общественными науками.

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

Александр Петрович, руководитель отдела технической документации из Macroscop, советует досконально изучать интересующую область:

«Я считаю, что стартовать надо в той области знаний, в которой вы компетентны. Либо прокачать свои знания в той сфере, с которой вы планируете начать свой путь техписателя. Для работы в IT, например, я настоятельно рекомендую освоить как минимум HTML и CSS, а оптимально — ещё и основы JavaScript и распространённых веб-фреймворков.

Как сделать портфолио?

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

Включайте только документы, которые имеют отношение к техническому письму.
На ClickHelp рекомендуют найти что-то близкое из того, что вы уже писали. Главное, чтобы это был формальный текст с чёткой структурой, например, отчёт.
На Reddit делятся информацией о заданиях для техрайтеров, из которых можно собрать портфолио, даже если реальных задач ещё не было. Встречаются любопытные задания, например, переписать инструкцию по сборке мебели из IKEA словами.
Возьмите инструкцию к сервису и попробуйте её улучшить.
Примите участие в ежегодном Season of Docs от Google, где технические писатели создают документацию для реальных проектов.
Поищите опенсорсные проекты на GitHub и предложите им написать документацию для пользователей. Это поможет вам поработать над реальной задачей, получить отзывы, и повысит шансы на отбор в Season of Docs.

Путь поиска может быть непростым, даже если у вас есть базовые технические знания. Екатерина Каляева, технический писатель IT-компании Lad, в процессе обучения компьютерной лингвистике решила пойти в техрайтеры:

Что же я вкладываю в понятие портфолио. Мое Портфолио – это мая визитная карточка, которая говорит сама за себя и не нуждается в дополнительном пояснении. Проектированием я занимаюсь достаточно давно, чтобы накопить богатый опыт.

Цель этого раздела показать количество и качество выполненных мною проектов инженерных систем, а также реализованных объектов автоматизации, электрификации, модернизации и так далее.

Само портфолио разбито по годам моей работы. Где-то я буду выкладывать примеры листов из проектов, где-то будут фотографии реальных объектов и оборудования. Это, например, могут быть фотографии шкафов управления, реально собранных моими руками и запущенных на объекте. Это могут быть фотографии объектов, в которых я принимал участие как инженер или как руководитель (например трансформаторные подстанции, насосные станции, станции дозирования и т.п.).

Некоторые работы я специально вынес в раздел «Архивы работ«, где я более подробно описываю объект проектирования, коротко рассказываю о разрабатываемых системах. Эти работы смогут чуть-чуть лучше дать понимание о моих возможностях, как инженера проектировщика, инженера — наладчика.

P.S. Раздел находится в процессе заполнения и тестовой наладке, поэтому прошу не судить строго. Как только настрою приемлемый для меня внешний вид этого раздела, уберу эту запись. Уже заполнил 2005 и 2006 год. Сейчас тружусь над заполнением 2007 и 2008 года. Также закончил 2019 год.

Работы 2020 года

Работы 2019 года

Работы 2018 года

В 2018 году проектных работ было не очень много, но они были объемные.

Много было монтажа, сборочных и пусконаладочных работ. Объект был один — насосная станция водопроводной воды в станице Старочеркасской Ростовской области. В работах на насосной станции можно выделить две системы, на которые собирал шкафы управления и запускал их в работу: автоматика блочно-модульной двух трансформаторной подстанции 10/0,4 кВ и систему АСУТП самой насосной станции.

Автоматика трансформаторной подстанции

АСУТП насосной станции

Проекты 2008 года

Проекты 2007 года

Портфолио работ до 2006 года включительно

Рабочий проект. Система контроля и управления доступом. Год исполнения - 2006. Объект: Кредитно-Кассовый Офис г.Новороссийск ул.ХХХХХХ, д.ХХХ" data-src="https://alexustinovski.ru/gallery/2005-2006/skud-2006-novorosisk.jpg" data-thumbnail="https://alexustinovski.ru/gallery/2005-2006/thumbs/thumbs_skud-2006-novorosisk.jpg" data-image-id="30" data-title="Система СКУД" data-description /about_me/">Рабочий проект. Система контроля и управления доступом. Год исполнения - 2006. Объект: Кредитно-Кассовый Офис г.Новороссийск ул.ХХХХХХ, д.ХХХ" data-image-slug="skud-2006-novorosisk" rel="7644f0596683d4c0f5fd210240ad68f0">

Рабочий проект. Система охранного телевидения. Год исполнения - 2006. Объект: Кредитно-Кассовый Офис г.Новороссийск ул.ХХХХХХ, д.ХХХ" data-src="https://alexustinovski.ru/gallery/2005-2006/sot-2006-novorosisk.jpg" data-thumbnail="https://alexustinovski.ru/gallery/2005-2006/thumbs/thumbs_sot-2006-novorosisk.jpg" data-image-id="31" data-title="Система охранного телевидения" data-description /about_me/">Рабочий проект. Система охранного телевидения. Год исполнения - 2006. Объект: Кредитно-Кассовый Офис г.Новороссийск ул.ХХХХХХ, д.ХХХ" data-image-slug="sot-2006-novorosisk" rel="7644f0596683d4c0f5fd210240ad68f0">

Рабочий проект. Система охранно-пожарной и тревожной сигнализации. Система оповещения людей о пожаре. Год исполнения - 2006. Объект: Кредитно-Кассовый Офис г.Ростов-на-Дону ул.ХХХХХХ, д.ХХХ" data-src="https://alexustinovski.ru/gallery/2005-2006/opts-2006-shaumana.jpg" data-thumbnail="https://alexustinovski.ru/gallery/2005-2006/thumbs/thumbs_opts-2006-shaumana.jpg" data-image-id="32" data-title="Охранно-пожарная и тревожная сигнализация" data-description /about_me/">Рабочий проект. Система охранно-пожарной и тревожной сигнализации. Система оповещения людей о пожаре. Год исполнения - 2006. Объект: Кредитно-Кассовый Офис г.Ростов-на-Дону ул.ХХХХХХ, д.ХХХ" data-image-slug="opts-2006-shaumana" rel="7644f0596683d4c0f5fd210240ad68f0">

Система контроля и управления доступом. Год исполнения - 2006. Объект: Кредитно-Кассовый Офис г.Ростов-на-Дону ул.ХХХХХХ, д.ХХХ" data-src="https://alexustinovski.ru/gallery/2005-2006/skud-2006-shaumana.jpg" data-thumbnail="https://alexustinovski.ru/gallery/2005-2006/thumbs/thumbs_skud-2006-shaumana.jpg" data-image-id="33" data-title="Система контроля доступа" data-description /about_me/">Система контроля и управления доступом. Год исполнения - 2006. Объект: Кредитно-Кассовый Офис г.Ростов-на-Дону ул.ХХХХХХ, д.ХХХ" data-image-slug="skud-2006-shaumana" rel="7644f0596683d4c0f5fd210240ad68f0">

Система видеонаблюдения. Год исполнения - 2006. Объект: Кредитно-Кассовый Офис г.Ростов-на-Дону ул.ХХХХХХ, д.ХХХ" data-src="https://alexustinovski.ru/gallery/2005-2006/sot-2006-shaumana.jpg" data-thumbnail="https://alexustinovski.ru/gallery/2005-2006/thumbs/thumbs_sot-2006-shaumana.jpg" data-image-id="35" data-title="Система СОТ" data-description /about_me/">Система видеонаблюдения. Год исполнения - 2006. Объект: Кредитно-Кассовый Офис г.Ростов-на-Дону ул.ХХХХХХ, д.ХХХ" data-image-slug="sot-2006-shaumana" rel="7644f0596683d4c0f5fd210240ad68f0">

Рабочий проект. Система охранно-пожарной и тревожной сигнализации. Система оповещения людей о пожаре. Год исполнения - 2006. Объект: Кредитно-Кассовый Офис г.Краснодар ул.ХХХХХХ, д.ХХХ" data-src="https://alexustinovski.ru/gallery/2005-2006/opts-2006-starokubanska.jpg" data-thumbnail="https://alexustinovski.ru/gallery/2005-2006/thumbs/thumbs_opts-2006-starokubanska.jpg" data-image-id="36" data-title="Охранно-пожарная и тревожная сигнализация" data-description /about_me/">Рабочий проект. Система охранно-пожарной и тревожной сигнализации. Система оповещения людей о пожаре. Год исполнения - 2006. Объект: Кредитно-Кассовый Офис г.Краснодар ул.ХХХХХХ, д.ХХХ" data-image-slug="opts-2006-starokubanska" rel="7644f0596683d4c0f5fd210240ad68f0">

Система контроля и управления доступом. Год исполнения - 2006. Объект: Кредитно-Кассовый Офис г.Краснодар ул.ХХХХХХ, д.ХХХ" data-src="https://alexustinovski.ru/gallery/2005-2006/skud-2006-starokubanska.jpg" data-thumbnail="https://alexustinovski.ru/gallery/2005-2006/thumbs/thumbs_skud-2006-starokubanska.jpg" data-image-id="37" data-title="СКУД" data-description /about_me/">Система контроля и управления доступом. Год исполнения - 2006. Объект: Кредитно-Кассовый Офис г.Краснодар ул.ХХХХХХ, д.ХХХ" data-image-slug="skud-2006-starokubanska" rel="7644f0596683d4c0f5fd210240ad68f0">

Отбирая претендентов на должность, рекрутеры руководствуются кадровой политикой компаний. Работодатели чаще выбирают кандидатуры, которые могут работать в команде, полностью соответствуют заявленным требованиям и имеют универсальные навыки. Для составления собственной самопрезентации мы рекомендуем использовать шаблон резюме инженера-проектировщика, образец которого мы подробно рассмотрим ниже. Заполнив его, вы сможете выгодно представить себя как личность и как профессионала. Наши советы помогут повысить ваши шансы на трудоустройство.

Пример резюме инженера-проектировщика

в среднем 4,60 (5 голосов)

Примеры резюме в смежных специализациях:

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

Общие рекомендации по составлению анкеты инженеру-проектировщику

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

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

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

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

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

Заполнение информации об опыте работы

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

Перечислять должностные обязанности нужно кратко. Располагайте список по приоритетному значению.

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

Для отражения профессиональной значимости опишите достижения, выражая их количественными показателями.

Профессиональный шаблон HTML5. Отзывчивый, полностью настраиваемый с помощью простого Drag-n-Drop редактора Nicepage. Отрегулируйте цвета, шрифты, верхний и нижний колонтитулы, макет и другие элементы дизайна, а также контент и изображения.

Настроить с помощью Nicepage

При использовании Конструктор шаблонов HTML5 вы сможете настраивать цвета, шрифты, верхний и нижний колонтитулы, макет, столбцы и другие элементы дизайна, а также контент и изображения.

Your browser does not support HTML5 video.

Редактировать шаблон в автономном режиме

1. Загрузите и установите версию Nicepage для Windows, Mac, WordPress и Joomla с страница загрузки
2. Создайте новую страницу или выберите существующую.
3. Нажмите "Добавить новый блок", найдите идентификатор 439975 и нажмите "Ввод".

Читайте также: