Оглавление

Введение
Преимущества
Выбор платформы
Что написать?
Структура
Зачем писать на тему, даже если на эту же тему уже есть много статей?
Длина статьи
Что делать, если статья слишком длинная?
Открытый исходный код и техническое письмо
Нужно ли вам быть техническим писателем, чтобы быть успешным разработчиком/дизайнером?
Несколько полезных советов
Вывод



Введение

«Техническое письмо — это практика документирования процессов, таких как руководства по программному обеспечению или учебные материалы».

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

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



Преимущества

Теперь вы можете подумать: «Почему я должен начать писать?»🤔 Итак, я перечисляю здесь некоторые преимущества, чтобы помочь вам решить:

1. Например, вы пишете статью о Flexbox в CSS. Чтобы сделать это, первое, что вы сделаете, это исследование. При этом вы можете узнать гораздо больше, чем знали раньше!

2. Вы получаете возможность зарабатывать деньги в Интернете.

3. Вы можете работать удаленно.

4. Вы можете работать с замечательными технологическими компаниями и писать для них.

5. Вы можете продемонстрировать свои собственные знания. Если вы написали статью, которая действительно хорошо объясняет определенную тему, это означает, что вы действительно «знаете» о ней. Например, вы написали статью на тему React.js. Возможно, один из читателей из компании, которая в настоящее время нанимает разработчиков React. Этот читатель может порекомендовать вас своей компании.

6. Если вы пишете в социальных сетях, таких как Twitter, вы можете увеличить аудиторию. Люди из этой аудитории могут стать первыми пользователями вашего Saas.

7. Получайте отзывы от разработчиков со всего мира.

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



Выбор платформы

Как только вы решили, что начнете писать, следующее, о чем вы можете подумать, это о том, где писать👀

Некоторые хорошие платформы для разработчиков — hashnode, dev.to и medium. У этих платформ огромное сообщество, а это значит, что люди будут читать то, что вы пишете. Вам не придется начинать с нуля, чтобы найти читателей. Публикация здесь для новичков принесет вам большую пользу.

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

Лучшим способом будет кросс-пост на разных платформах, чтобы максимизировать показ ваших статей! Например, я делаю кросспост на hashnode и dev.to. Я также делюсь своими статьями в Twitter. Иногда мои статьи отлично работают на hashnode, но не так хорошо на dev.to. Тем не менее, я получаю большую пользу. Это все из-за кросспостинга.

Даже если у вас есть собственный блог, вы можете сначала опубликовать свою статью там, а затем сделать кросс-пост на этих платформах, чтобы получить максимальную выгоду!

Что написать?

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

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

Дело в том, что вы можете сузить или расширить нишу по своему желанию. Вы можете выбрать веб-разработку в целом как свою нишу или сузить ее до JavaScript, это все ваш выбор!

PS:

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



Структура

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

Поскольку я пишу о техническом письме, я сначала представил, что это такое, его преимущества, порекомендовал некоторые платформы, объяснил, что писать, а затем начал обсуждать структуру. Если бы я сначала объяснил, какой должна быть длина статьи, затем обсудил платформы, а затем представил техническое письмо, ничего не имело бы смысла, верно? Следовательно, чрезвычайно важно структурировать свои статьи таким образом, чтобы все двигалось по порядку. Это потому, что это помогает пользователю понять, о чем вы пишете!



Зачем писать на тему, даже если на эту же тему уже есть много статей?

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

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



Длина статьи

Честно говоря, заранее определенной длины статьи нет.

Например, если я напишу статью про «UX открытия ссылок», она вообще не будет длиннее 500 слов. Так что, если я думаю, что нет, моя статья должна состоять как минимум из 800 слов и продолжать тянуть ее, никому это не понравится. Итак, пока ваше сообщение передается, даже если оно состоит из 300 слов, это потрясающая статья. Не беспокойтесь о длине!



Что делать, если статья слишком длинная?

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

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

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

Давайте обсудим другой случай. Вы пишете статью, чтобы научить других делать приложение-счетчик с помощью React.js. Эта статья определенно будет длинной. Если такой читатель, как я, увидит длинную статью из 4000 слов, он просто проигнорирует ее и найдет другой ресурс. Для того, чтобы получить их полный фокус, разделите его на части. Если это статья на 4000 слов, разделите ее на 3 части или 2 части, это ваш выбор. Кроме того, включите оглавление для каждой части.



Открытый исходный код и техническое письмо

Некоторым из вас это может показаться чуждым понятием, но поверьте мне, это не так! Вы можете внести свой вклад в открытый исходный код, написав техническое письмо. Например, вы можете написать README для проекта, помочь с документацией проекта и т. д. Звучит интересно, правда?

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



Нужно ли вам быть техническим писателем, чтобы быть успешным разработчиком/дизайнером?

Ответ большой жир НЕТ!

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



Несколько полезных советов

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

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

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

— Будьте внимательны: Предоставьте достаточно подробностей, чтобы подтвердить свою точку зрения. Но не делайте объяснение слишком длинным, чтобы утомить читателя.

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




Вывод Твиттер

Гитхаб