Как написать разработчикам


Как правильно написать запрос в службу технической поддержки FirstVDS

Хоть мы и не Гугл, и даже не Яндекс, нам довольно часто пишут в поддержку: хостинг — дело серьезное.

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

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

Три главных правила для составления запроса:

1. Сформулируйте суть проблемы

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

Для сравнения возьмем два запроса об одной и той же проблеме:

Запрос №1: 

«Здравствуйте, поддержка хостинга, где я размещаю свои сайты. Достаточно давно не заходил на свой сайт, а сегодня утром, когда включил компьютер, с удивлением обнаружил, что он не загружается. Возникли подозрения, что есть какая-то проблема на сервере, из-за чего сайт перестал грузиться, зайти на сервер не смог, вроде не подошел пароль. Прошу как можно скорее помочь!»

Запрос №2:

«Здравствуйте!
1. На сервере 123.45.67.89 не загружается сайт domen.ru, возникает ошибка 500 Server Error (скриншот). 
2. Зайти на сервер не удалось, подключался так:
ssh [email protected] -p22 
с паролем RiDFuk3E»

Из примеров наглядно видно, что по Запросу №2 можно сразу приступать к диагностике работы сервера 123.45.67.89, чтобы установить причины ошибки 500 на сайте domen.ru. По Запросу №1 нужно сперва выяснить: о каком сервере идет речь, какой сайт не работает, как возникает ошибка, с каким паролем не удается подключиться. Таким образом, выяснение информации потребует участия клиента и займет какое-то время, а значит к решению проблемы техподдержка приступит значительно позже, чем в случае с Запросом 2.

2. Создавайте отдельные тикеты на разные вопросы

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

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

3. Проверьте, нет ли готового ответа на ваш вопрос

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

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

Шаг 1. Собираем данные для написания запроса

1. Если сервер недоступен

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

  • Есть ли пинг до сервера?
  • Сайт открывается не только по домену, но и по IP-адресу? В ином случае см. пункт 2.
  • Панель управления открывается? Есть SSH/FTP-доступ?
  • Нет ли проблем с вашим интернет-соединением? Попросите друга попробовать зайти на сервер и узнать, будет ли проблема у него.
  • Баланс лицевого счета положительный и услуги не остановлены? Нет запроса о блокировке или уведомления в личном кабинете о каких-либо работах?
  • Сервер доступен через VMmanager по VNC или Shell-доступ(OVZ)? Если да, см. пункт о проблемах сети.

2. Если сайты недоступны (но сервер доступен, в ином случае см.п. 1)

Лучше всего собрать ответы на следующие вопросы и кратко описать их в тексте запроса:

  • Как давно сайты перестали открываться?
  • Не делали ли вы что-либо с сайтом, прежде чем проблема возникла?
  • Нет ли проблем с вашим интернет-соединением? Попросите друга попробовать зайти на ваш сайт и узнать, будет ли проблема у него.
  • Проблема возникла впервые или уже такое было? Как разрешилась проблема в прошлый раз? Сколько времени сайты не работали?
  • Какой у вас браузер, его версия? Может быть, вы недавно сменили браузер? Как работают сайты с другого браузера?
  • Какая ошибка возникает при открытии сайта? Пишет ли браузер «Превышен интервал ожидания запроса?» Или может возникает серверный код ошибки, например ошибка 502?
  • Возможно, вы уже обращались в техподдержку по этому же вопросу ранее? Что вам ответили?
  • Пример имени сайта, который не открывается? Не открываются все сайты? Или только один? Или только несколько?

3. Не пускает с логином и паролем в ISPmanager, BILLmanager, phpMyAdmin, FTP, MySQL, Почтовый клиент, SSH или в другое место.

  • Какие данные вы указываете при подключении? Хост, порт, логин и пароль.
  • Какую ошибку вы видите при подключении?
  • Проблема остается при авторизации под другим пользователем?
  • Нет ли проблем с вашим интернет-соединением? Попросите друга попробовать подключиться и узнать, будет ли проблема у него.
  • Какое ПО вы используете для подключения, его версия? Может быть, вы недавно сменили, обновили это ПО? Попробуйте подключиться, используя другое аналогичное ПО?

4. Не запускается программное обеспечение.

  • Какое программное обеспечение вы запускаете? Как вы запускаете ПО?
  • Возможно ли запустить данную программу через консоль?
  • Какую ошибку вы видите при запуске программы через консоль?
  • Что пишется в логах запускаемого программного продукта?
  • Вы писали в техническую поддержку этого программного продукта? Какой ответ?
  • Как должен выглядеть успешный запуск программного обеспечения?

5. Отправка и принятие почты.

  • С какого на какой ящик почта не уходит/приходит? 
  • При отправке вы видите какие-либо ошибки?
  • На ящик отправителя приходит письмо с ошибкой? 
  • На другие почтовые ящики почта уходит/приходит? 
  • Какой почтовый клиент вы используете? 
  • Или вы используете скрипт при отправке? Какой? 
  • Работала почта раньше? Отправляли ли рассылки?

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

  • Что делать, если мои письма не доходят или попадают в папку «спам»?
  • Работа с почтовым сервером exim при блокировке почтового трафика
  • Как настроить отправку почты с нового VDS
  • Настройка почты на сервере в панели ISPmanager 5
  • Как настроить почту для Bitrix GT
  • Настройка почты на VM Bitrix

6. Проблемы сети.

  • Какой IP компьютера, с которого у вас наблюдается проблема?
  • На другом устройстве и при выходе в интернет через другого провайдера проблема сохраняется?
  • Для анализа проблемы необходимо, чтобы вы при помощи утилиты mtr, сформировали детальный отчет, с соблюдением двух условий:
    • должно быть отправлено не менее 1000 пакетов;
    • мультитрейс должен быть сделан в обоих направлениях, то есть на проблемный сервер и с него в обратном направлении.

Способы установки mtr:

  • SuSE: через Yast 
  • Debian/Ubuntu: apt-get install mtr-tiny
  • Gentoo: emerge -av mtr 
  • FreeBSD: pkg install mtr-nox11 
  • Windows: winmtr http://winmtr.sourceforge.net  

Хорошо подойдет для диагностики следующий синтаксис, по окончанию будет выведен отчет:

 mtr -s 1000 -r -bw -c 1000 -i 0.1 www.ya.ru 

Тест обычно занимает около 3-4 минут.

При запуске Winmtr на Windows использовать синтаксис, указанный выше, не нужно. Достаточно указать проблемный IP, запустить мультитрейс и дождаться, когда счетчик покажет 1000 пакетов.

  • Добавляли/меняли ли ip-адреса и другие сетевые настройки на вашем сервере?
    Полезная статья на нашем сайте: Сетевые настройки в кластерах с технологией VPU

7. Не работает элемент сайта

  • На каком сайте возникает проблема?
  • Какая именно функция сайта не работает (импорт, корзина, страница, плагин, тема)?
  • Как воспроизвести проблему в работе сайта?
  • Проблема сохраняется в различных браузерах с различных устройств и провайдеров интернета?
  • На сайте отсутствуют вирусы? Инструкция по поиску вирусов в панели ISPmanager
  • Какой результат должен быть при корректной работе функции сайта?

8. Установка дополнительного программного обеспечения на сервер.

  • Что вы пытаетесь установить?
  • Какую команду для этого вы запускаете? Может вы пользуетесь какой-то инструкцией?
  • Какую ошибку вы видите при установке?
  • Соответствует ли сервер техническим требованием устанавливаемого вами ПО?

Шаг 2. Пишем запрос

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

А именно:

  • Если у вас подключено несколько проектов (FirstVDS или 1Dedic), выбирайте нужный проект в правом верхнем углу личного кабинета.
  • Выбирайте нужную услугу (очень важно). Даже если она у вас одна. Без выбранной услуги у сотрудников поддержки не отобразится информация по вашей услуге и им придется сначала опираться только на ваш текст, а уже потом, исходя из понимания вашего текста, выбирать услугу.
  • Придерживайтесь официально-делового стиля, останавливаясь только на конкретике и фактах.
  • В теме указывайте суть проблемы.
  • Подробно описывайте проблему (ответьте на все перечисленные выше вопросы из того раздела, который относится к вашей проблеме).
  • Предоставьте сразу все необходимые для решения проблемы доступы (очень важно). Речь идет чаще всего о пароле и порте для доступа по SSH/FTP/ISPmanager, доступе в админ-панель сайта, доступ в почтовый ящик (если не работает почта) и т.д.
  • Если несколько вопросов на одну тему, разбейте их на отдельные пункты и визуально обозначьте это в тексте запроса (например: 
    1) ……….
    2) ……….
    и т.д.)
  • Если несколько вопросов на разные темы и по разным услугам, создайте по каждой отдельный запрос.

Итак, ознакомившись со всеми этими рекомендациями, вы ускорите решение по вашим запросам примерно в 2.5 раза, что, согласитесь, не мало. Но, напоследок, все же пожелаем вам поменьше сталкиваться с затруднениями и проблемами при работе с вашим VDS.

Как обратиться в поддержку ВКонтакте

Если ты сам решил, что тебе надо в поддержку, то сначала попробуй это:

У меня вопрос

Ты быстрее получишь решение своей проблемы и не надо будет долго ждать ответа.

Также ты можешь задать вопрос или найти готовый ответ в нашей группе ВКонтакте.

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

  • Забыл пароль
  • Забыл пароль и нет номера
  • Не входит в Контакт? Решение
  • Заморозили ВКонтакте. Что делать? Решение
  • Взломали страницу ВКонтакте

Создание запроса

С компьютера, ноутбука, планшета

Чтобы обратиться в службу поддержки ВКонтакте (агентам ВК) и получить помощь, открой эту страницу: Помощь по сайту ВКонтакте (откроется в новом окне).

Ты увидишь строку ввода, внутри которой есть подсказка: «Введите ваш вопрос». Начни там набирать свой вопрос или описание проблемы.

По мере того, как ты это вводишь, чуть ниже будут появляться уже существующие ответы на похожие вопросы — их можно сразу посмотреть. Выбери ответ, который соответствует твоей проблеме. Нажми на него, там будет написано, что делать. Если ответ предусматривает обращение в службу поддержки, то внизу будет синяя кнопка, чтобы туда обратиться. Ты сможешь отправить запрос в поддержку, и на него ответит живой сотрудник, но ответа придется подождать. Срок ожидания тебе подскажут — например, 38 часов. Это ориентировочно! Согласен? Нажимай «Задать вопрос», опиши проблему кратко, но четко, и нажми «Отправить».

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

Если не получается найти, как задать вопрос в поддержку, попробуй набрать слова напишите нам — появится фраза «Если найти нужную статью не получилось, напишите нам» — нажми на «напишите нам» и затем «Задать вопрос».

Для обращения в официальную поддержку ВК напрямую, минуя предлагаемые ответы и решения проблем, можно обратиться по этой ссылке: Новый вопрос. Еще раз обрати внимание: ждать ответа тебе придется достаточно долго, а в 95% случаев решение уже есть тут: Готовые решения проблем ВК — просто найди его и прочитай.

С телефона, планшета через мобильное приложение ВК

Первый способ
  1. Открой боковое меню (нажми на свою аватарку слева вверху или проведи пальцем по экрану слева направо).
  2. Настройки.
  3. О приложении.
  4. Обратная связь.
  5. Заполни все поля, при необходимости прикрепи файлы и отправь запрос (кнопка справа вверху).
Второй способ
  1. Открой боковое меню (нажми на свою аватарку слева вверху или проведи пальцем по экрану слева направо).
  2. Настройки.
  3. Помощь.
  4. Выбери тему вопроса.
  5. Выбери один из готовых ответов, наиболее близкий к твоей проблеме.
  6. Пролистай его до конца.
  7. Если ответ предусматривает обращение в поддержку, там будет кнопка для создания запроса.
  8. Заполни все поля, при необходимости прикрепи файлы и отправь запрос.

Через мобильную версию сайта (в браузере с телефона, планшета)

Первый способ
  1. Пятая кнопка в нижнем ряду.
  2. Еще.
  3. Помощь.
  4. Выбери тему вопроса.
  5. Выбери один из готовых ответов, наиболее близкий к твоей проблеме.
  6. Пролистай его до конца.
  7. Если ответ предусматривает обращение в поддержку, там будет кнопка для создания запроса.
  8. Заполни все поля, при необходимости прикрепи файлы и отправь запрос.
Второй способ
  1. Создай запрос по прямой ссылке: Новый вопрос.
  2. Заполни все поля, при необходимости прикрепи файлы и отправь запрос (кнопка справа вверху).

Где ответ от службы поддержки? Как узнать, что мне ответили? Страница «Мои вопросы»

В браузере на компьютере и на телефоне

Ответ на твой вопрос появится на странице «Мои вопросы»: Мои вопросы и ответы от поддержки ВКонтакте (откроется в новом окне). Возможно, у тебя запросят какую-нибудь дополнительную информацию, следи за уведомлениями в СМС.

В мобильном приложении ВК

  1. Открой боковое меню (нажми на свою аватарку слева вверху или проведи пальцем по экрану слева направо).
  2. Настройки.
  3. Помощь.
  4. Мои вопросы.

Насчет удаленных фото и других материалов

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

Если обидели, оскорбили, унизили

Есть разные способы, как поступить с обидчиком или неадекватным человеком. Об этом подробно рассказано здесь: Что делать, если оскорбили ВКонтакте.

Почему поддержка ВКонтакте не отвечает? Когда мне ответят? Сколько нужно ждать?

Смотри подробности здесь:

  • Когда мне ответит служба поддержки ВК? Почему не отвечает? Почему время ответа увеличивается?

Легкий вход в Контакт

Для легкого входа на сайт ВКонтакте, другие социальные сети и почту пользуйся стартовой страницей Vhod. ru.

Вход: стартовая страница

Смотри также

  • Не входит в ВК? Как войти? Решение
  • Забыл пароль или нет номера, не могу восстановить доступ
  • Заблокировали страницу ВК. Что делать? Как разблокироваться?
  • Что делать, если взломали страницу ВКонтакте
  • Как вернуть старую версию ВКонтакте
  • Как восстановить удаленное фото ВКонтакте
  • Мошенники ВКонтакте. Как пожаловаться, можно ли наказать и вернуть деньги?
  • Что делать, если оскорбили ВКонтакте
  • Как удалить свою страницу ВКонтакте
  • Как пользоваться ВКонтакте? — Все советы

В начало: Как обратиться в поддержку ВКонтакте

Вход.ру

Как письмо может продвинуть вашу карьеру разработчика

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

Я получил вторую стажировку в колледже благодаря убедительному сопроводительному письму. Будучи новым выпускником, я получил свою первую работу, отправив холодное электронное письмо интересному стартапу, который нашел в Интернете. Когда несколько лет спустя меня поставили во главе инженерной группы, двое из моих первых сотрудников знали меня через мой блог еще до подачи заявки. А в 2020 году я оставил свою должность технического директора, чтобы начать бизнес по написанию технических текстов, потому что многие компании просили меня писать контент, ориентированный на разработчиков.

Хотя мой опыт может быть уникальным (очень немногие инженеры становятся профессиональными писателями), умение писать является важным навыком для всех нас в разработке программного обеспечения. Согласно статье IEEE, инженеры тратят большую часть своего дня на написание текстов, и по мере того, как они становятся старше, эта цифра только увеличивается: руководители среднего звена пишут от 50% до 70% рабочего дня; те, кто находится в высшем руководстве, по сообщениям, тратят более 70% и целых 95% своего рабочего дня пишет». – Джон Лейденс, цитируется в The Writer Engineer

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

Разработка программного обеспечения — это командный вид спорта

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

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

«В каждой отрасли есть истины, которые очевидны для тех, кто работал в этой отрасли, но могут удивить тех, кто со стороны. Одна из таких истин для инженеров-программистов: наша работа связана с огромным количеством написания текстов». – Бен Маккормик, технический директор Kustomer

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

Как письмо может способствовать вашей карьере разработчика

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

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

1. Письмо способствует обучению

Мы, инженеры-программисты, должны постоянно узнавать что-то новое. Согласно последнему опросу разработчиков Stack Overflow, «75% респондентов отметили, что изучают новую технологию не реже одного раза в несколько месяцев или раз в год».

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

«Написать код для решения проблемы — это одно, а объяснить это решение сообществу разработчиков в Интернете — совсем другое. Вы хотите убедиться, что абсолютно точно знаете, что говорите; что означает исследования, много исследований!» – Даниэль Фири, специалист по связям с разработчиками в Strapi 9.0003

Эз Сандей, разработчик программного обеспечения и писатель-фрилансер, согласился, добавив: «Если вы не можете этому научить, значит, вы этого не знаете».

Я никогда не делал заметки, но всегда старался писать в блогах о новых вещах, которые я узнаю. Очень немногие из этих постов получили много читателей, но для меня они были отличным способом закрепить новые технологии или инструменты, которые я недавно изучил. Адам Дювандер, разработчик, консультант и автор книги « Маркетинг для разработчиков не существует 9».0010 дал мне похожий совет:

«Оглянитесь на свои последние коммиты. Выберите забавную техническую проблему, с которой вы столкнулись, и расскажите, как вы ее решили. Если вы будете делать это каждый месяц или два, у вас будет больше технических должностей, чем у любого другого работающего инженера». – Адам ДюВандер

2. Письмо может помочь вам найти работу и клиентов

Письмо может помочь закрепить темы, которые вы знаете, но это также окно в ваши навыки инженера-программиста.

«[Написание] — это социальное доказательство моей способности учиться публично», — сказал мне Дэн Мур, руководитель отдела по связям с разработчиками в FusionAuth. «Мое письмо сыграло важную роль в получении моей первой работы в отделе по связям с разработчиками, так как я познакомился с компанией на конференции и смог показать им примеры работы».

«Всей своей карьерой я обязан паре статей, которые написал», — сказал мне Адам Дювандер. «Учебник, который я написал на Webmonkey, привел к моей первой работе разработчиком. Они видели, как я обсуждал технологию, и еще до того, как мы поболтали, знали, что я справлюсь с работой». Далее он добавил, что письмо помогло ему получить работу в ProgrammableWeb среди других карьерных возможностей. «Вся моя карьера на самом деле сводится к писательству», — сказал он.

Стефани Морилло, руководитель технической программы и автор В Руководстве разработчика по созданию контента было несколько примеров того, как писательство помогло ей в ее карьерном пути:

«Однажды я получил предложение присоединиться к стартапу облачных вычислений в качестве копирайтера благодаря нескольким блогам. сообщения, которые я написал. В середине 2010-х я написал несколько статей о технической культуре и смог добиться от них выступлений на конференциях. Мне предложили роль технического писателя на неполный рабочий день в организации с открытым исходным кодом, и я даже начал заниматься копирайтингом на стороне для агентств [разработки программного обеспечения]». – Стефани Морилло

Джон Грамила и Кинан Коппенхейвер, консультанты по программному обеспечению из Чикаго, имели похожие истории получения новых клиентов благодаря статьям, которые они опубликовали на различные темы разработки программного обеспечения. «Люди хотят участвовать и хотят протянуть руку помощи, — сказал Кинан, — но если вы никогда не выставите себя напоказ в том, что написали, вы не увидите многих из этих возможностей».

3. Написание книг может привести к написанию книг и публичным выступлениям

Еще в 2017 году я поставил перед собой задачу писать что-нибудь каждый день. Большинство частей, которые вышли из этого эксперимента, были случайными темами программирования, которые я изучал, но около трех месяцев я сосредоточился на серии статей об использовании PHP с Docker.

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

У Дэна Мура был похожий опыт, когда он превратил коллекцию своих сообщений в блоге в полноформатную книгу ( Letters to a New Developer ). Джеймс Хикки, старший инженер-программист и Microsoft MVP, повторил аналогичные возможности благодаря своему письму. «Многие люди обращались ко мне по поводу работы по контракту, просто читая мой блог, и за последние пару лет у меня было много предложений написать книги».

Адам Дювандер отметил, что участие в таких проектах, как написание книги или выступление на конференции, также является отличительной чертой карьеры. «Вместо того, чтобы конкурировать со всеми другими инженерами, вы становитесь The Choice в своей области», — сказал он мне. «Напишите об этом, и если будет достаточно делового интереса, вы найдете отличную роль».

4. Сохраняет вашу личную историю

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

Стефани Морилло сказала мне, что рекомендует разработчикам попробовать вести журнал. «Ведение журнала дает вам возможность писать, не стесняясь, потому что вы пишете не для аудитории; ты делаешь это для себя».

Дэн Мур добавил, что «письмо служит исторической записью, но, что более важно, оно проясняет ваши мысли. Я часто записываю вопрос или проблему, с которой столкнулся, и обнаруживаю, что вижу новые возможности для исследования».

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

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

5. Написание текстов открывает новые карьерные возможности

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

«Варианты почти безграничны, но включают в себя продукт, техническое управление учетными записями, маркетинг, проектирование продаж и многое другое. Вы можете сочетать свой аутентичный технический опыт со способностью передавать его в роли, где эти навыки очень необходимы и редки». – Адам ДюВандер

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

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

Начало работы

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

Если вы хотите начать свой собственный блог, Medium, Dev.to и Hashnode — популярные варианты для разработчиков. Или, если вы предпочитаете, чтобы вам платили за то, что вы пишете, есть много отличных технических блогов, которые платят авторам.

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

Теги: карьерный совет, писательство

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

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

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

Привычки и инструменты

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

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

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

Оказывается, письменные принадлежности имеют значение. В технических статьях такие вещи, как текст, смешиваются с диаграммами, изображениями и кодом. Правильно отформатировать их, а затем экспортировать в конечную платформу публикации и проверить, все ли в порядке с форматом, — не всегда тривиальная задача. Я могу писать в Notion, экспортировать в Markdown, а затем вставлять в WordPress. Если вы планируете написать более одной статьи, то наладить этот процесс просто необходимо.

Будь автомобильным гудоком

Еще одна ошибка, которую нужно обойти, заключается в том, что если вы не полностью понимаете технологию, вы не можете писать о ней. Цель большинства технических постов — быть автомобильным гудком — объявить, что то, о чем вы пишете, здесь, актуально и должно быть замечено. Вы также можете выяснить, что стоит за этой технологией, какие мысли привели к ее появлению и как она помогает людям сегодня.

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

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

Введение внутренних терминов или идиом, если они на самом деле не выражают что-то без дальнейшего контекста, может затруднить понимание. Например, Rails описывается как «самоуверенный» — что и правдиво, и хорошо описывает, чего ожидать в дальнейшем. В то время как заявление о том, что в Java есть «сборка мусора», на самом деле не помогает понять сам язык. Во что бы то ни стало покажите людям ступени вниз в подвал, но сами по ним не исчезайте.

Пример

Вот пример подхода. В рамках статьи, как бы вы объяснили основы SQL в абзаце?

Должны ли вы начать с объяснения того, что SQL — это DSL (предметно-ориентированный язык — и да, если они не очевидны, вы также должны расшифровывать аббревиатуры)? Да, потому что знание того, что вы можете делать все с помощью ограниченного набора команд, имеет определенные последствия. Стоит ли объяснять историю Oracle? Нет, но, может быть, вы можете упомянуть, когда вы впервые работали с табличными данными, чтобы помочь установить контекст. Стоит ли вам исследовать реляционные базы данных? Конечно, вам придется немного объяснить о таблицах и схемах. Как насчет «первичных и внешних ключей»? Старайтесь изначально избегать использования самого внутреннего термина; начните с таких терминов, как «относится к» или «индекс».

На схемы и списки кодов. Ясно, что таблицу очень легко визуализировать и нарисовать (поэтому она так широко распространена), и вы можете тривиально показать как запрос, так и таблицы, с которыми он работает: Происхождение Яблоко Казахстан Банан Филиппины Вишня Румыния

ТАБЛИЦА наций

Имя Континент
Казахстан Европа/Средняя Азия
Филиппины Азия
Румыния Европа

Как спросить SQL, с какого континента происходят яблоки?

>выберите имя фрукта, страну. континент из фруктов, нация где fruit.origin = нация.название и fruit.name = 'яблоко'; +-------+---------+ | имя | континент | +-------+---------+ | яблоко | Европа / Центральная Азия | +-------+---------+

1

2

3

4

5

6

7

8

10

11

 

>выбрать фрукт.название, нация.континент

из фруктов, нация  

, где фрукт.происхождение = нация.название и фрукт.название = 'яблоко';

 

+--------+---------+

| имя  | континент             |

+-------+---------+

| яблоко | Европа / Центральная Азия |

+-------+-----------------------+

 


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

Кроме того, вместо того, чтобы говорить о первичных и внешних ключах, более эффективна диаграмма:

Однако обратите внимание, что нет причин ограничивать ваш пример сотрудниками, отделами и офисами! Лучше, конечно, использовать примеры, которые вам небезразличны.

Сосредоточьтесь на путешествии (и другие заключительные советы)

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

Непосредственное сравнение продуктов допустимо при сравнении соответствующих товаров, но гораздо менее полезно для просто схожих технологий. После того, как вы выбрали, вы, как правило, должны использовать технологию от начала до конца, поэтому полезнее показать полный путь пользователя. Сравнения полезны для презентаций («Акулий торнадо» — это как встреча «Челюстей» и «Твистера»), но с этого момента сосредоточьтесь на путешествии. Установите его, следуйте документации, пробуйте примеры. Где ты споткнулся?

Мне нравится использовать веб-сайты, которые работают как песочница для технологии. Например, при рассмотрении регулярных выражений было полезно показать непосредственные примеры с regexr. Это не только облегчает объяснение — посмотрите на мой замок из песка! — это также доказывает, что технология достаточно гибкая, чтобы ее можно было выразить несколькими способами.

Размещение технологий на временной шкале (рождение, рост, возможная смерть) — это естественный способ дать контекст, но еще полезнее он для выявления меняющихся потребностей и возможных встроенных проблем. «Это было начато до облачных вычислений» неявно говорит вашей аудитории, где может лежать новое направление.

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


Learn more

Только новые статьи

Введите свой e-mail

Видео-курс

Blender для новичков

Ваше имя:Ваш E-Mail: