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

Блог — это полезная вещь по многим причинам не только для вас, но и для других разработчиков программного обеспечения в сфере технологий. Техническое письмо помогает разработчику программного обеспечения поделиться своими техническими знаниями/опытом с другими разработчиками программного обеспечения в области разработки программного обеспечения. Техническое письмо — это дисциплина письма, которая предполагает передачу сложной информации тем, кому она нужна для выполнения определенной задачи или достижения определенной цели. По этой причине техническое письмо часто определяют как « ». упрощение сложного Это также улучшает ваше понимание темы, о которой вы пишете, и ясно демонстрирует ваши технические знания. Самая уникальная особенность технического письма заключается не только в том, что вы можете создать отличные возможности в будущем (удаленная работа в сфере технологий, контракт на написание внештатных статей или возможность гостевой публикации на веб-сайте крупной технологической компании и т. д.), но и в том, что оно может помочь вам создать присутствие в Интернете, которое в конечном итоге поможет вам в вашей карьере разработчика программного обеспечения. Иногда я возвращаюсь и читаю сообщения в блоге, когда ищу информацию по определенной теме. Если вы сделали что-то интересное в своей карьере разработчика программного обеспечения, но держите это при себе, вы упускаете большой генератор возможностей. Начните писать, и это станет эффективным способом продвижения ваших идей в Интернете. «Напишите блог, который вы хотели бы найти, когда… https://t.co/PcXR0fL9QF — Анкур💻🎧💪 (@TheAnkurTyagi) 3 октября 2023 г. Кроме того, если вам нравится помогать другим учиться, вам нравится участвовать в проектах с открытым исходным кодом и показывать другим, как к ним присоединиться, или вы испытываете удовлетворение, объясняя сложные идеи простыми для понимания способами в своих текстах, то техническое письмо отлично подойдет для вас. ты. В этой статье я пытаюсь объяснить, как программирование и писательство могут объединиться, чтобы повысить наши навыки разработчика. Да, пишу! Я искренне считаю, что мы все обладаем определенным уровнем писательских способностей. Я здесь, чтобы дать вам советы, советы и примеры по написанию статей, которые помогут вам стать более опытным разработчиком и коммуникатором. Что такое техническое письмо Техническое письмо — это предоставление четких и подробных инструкций, которые помогут пользователям, коллегам-разработчикам или менеджерам понять технический продукт, технические навыки или идею. Технический писатель — это тот, кто создает эти учебные пособия и техническую документацию. Техническое письмо может быть: или интеграцию между Как использовать руководства пользователя двумя техническими SaaS Статьи онлайн-поддержки , в которых представлена информация по определенной теме, часто после проведения исследований или экспериментов. Они распространены в научной и инженерной областях. Технические отчеты . В этих документах четко и убедительно излагаются план, идея или проект. Они используются для поиска одобрения, финансирования или сотрудничества. Технические предложения Внутренние метаматериалы для программистов и для разработчиков. документация по API По сути, технический писатель передает технические детали таким образом, чтобы читатель мог эффективно применить эту информацию для конкретной цели. Если вы начинаете писать технические статьи и пытаетесь писать о разработке/программировании программного обеспечения или о том, чему вы научились в области технологий, но еще не написали свой первый блог, наибольшую ценность вы найдете в первых двух разделах статьи. это сообщение в блоге, где я рассказываю о том, как начать работу в качестве технического писателя или блоггера и как масштабировать свой блог. Остальная часть блога будет полезна для заполнения любых пробелов в знаниях, которые вам понадобятся, чтобы добиться успеха в качестве писателя-разработчика программного обеспечения, преуспеть на рабочем месте и продвинуться по карьерной лестнице. «Если у вас есть мечта, вы можете потратить всю жизнь на ее изучение, планирование и подготовку к ней. Что вам следует сделать, так это начать». —Дрю Хьюстон Письмо повсюду? Два самых популярных онлайн-ресурса, которые люди используют для обучения программированию, — это техническая документация и Stack Overflow, а замыкают тройку лидеров блоги. Триединство предоставления людям возможности самостоятельно изучать технологии включает в себя четкую документацию, активное сообщество, предлагающее решения, и частые публикации. Разработчики ценят широкий спектр дополнительных источников, включая обучающие видеоролики, письменные руководства, книги и форумы — они объединяют источники и форматы, которые лучше всего соответствуют их стилю обучения. Умение четко выражать свои идеи внутри команды и в Интернете — ценный навык, поскольку многим разработчикам это сложно. Просто подумайте о том, сколько вы пишете каждый день, не предполагая написания кода. Этот навык является суперсилой. Вы участвуете в различных формах написания, таких как чаты Slack, электронные письма, внутренняя документация для разработчиков, черновики RCA, файлы readme, комментарии к коду, сообщения о фиксации Git, запросы на включение, комментарии к проверке кода, ежегодные отзывы о производительности, заметки о встречах и многое другое. Освоение письма имеет решающее значение для разработчиков программного обеспечения. Недостаточные навыки письма могут препятствовать их карьерному росту после определенного момента. Многие инженеры позже в своей карьере осознают, что «мягкие навыки имеют такое же значение, как и код». Молодежь: ваша карьера в области разработки программного обеспечения значительно улучшится, и вы получите больше возможностей в будущем в сфере технологий, если начнете писать по 30 минут каждый день и публиковать 2-3 блога в Интернете каждый месяц, но очень немногие разработчики действительно могут делать это в течение длительного времени. долгосрочный. https://t.co/damIJ5gXys – Анкур💻🎧💪 (@TheAnkurTyagi) 4 октября 2023 г. Почему написание имеет решающее значение для разработчиков JavaScript, TypeScript, PHP, Go, Java — существует очень много разных языков программирования, и вы, возможно, даже свободно владеете многими из них. Поскольку мы стремимся создавать более качественный код в нашей технической карьере, способность писать и эффективно общаться на повседневном языке становится важнейшим навыком, который можно недооценивать в области разработки программного обеспечения. Программная инженерия — это не только код. Речь идет о людях + коде. Как я стал лучшим писателем, работая инженером-программистом То, как инженеры формулируют свои мысли о коде, может быть столь же важным, как и сам код. Независимо от вашей позиции по этому вопросу, мы можем единогласно признать, что наши слова способны как повысить, так и помешать эффективности кодекса. Письмо может помочь вам увеличить площадь поверхности удачи. L = D * T, где L — удача, D — делание, T — рассказ. – Джейсон С. Робертс 6 основных преимуществ технического письма Это помогает вам понять концепции на более глубоком уровне. Вам необходимо изучить концепции, которые вы объясняете, что откроет перед вами различные идеи, приложения и ошибки. Концепции лучше закрепляются в вашем мозгу, когда вы объясняете их другим. Структурируя и представляя информацию другим, вы часто обнаруживаете пробелы в своих знаниях. В результате это также поможет вам быстрее прогрессировать в карьере разработчика. Технические писатели учатся всю жизнь, потому что с каждым новым техническим блогом, в котором вы исследуете и пишете, вы становитесь экспертом в этой теме. Письмо также способствует более глубокому пониманию эмпатии пользователя. Это побуждает вас больше сосредоточиться на точках зрения и чувствах читателей или пользователей продукта, а не полагаться исключительно на свою точку зрения. Вот некоторые дополнительные преимущества: Кроме того, вы можете получать доход в качестве технического писателя, сотрудничая с различными организациями. Посмотрите эти . потрясающие компании, которые платят техническим писателям В колледже я учился, обучая других в общежитии. Объяснение чего-либо или даже притворство заставляет вас систематизировать свои знания, выявляя пробелы в знаниях и закрепляя те части, которые вы знаете. Лучший способ учиться — преподавать, а письмо — это большой актив для каждого разработчика. Вместо того, чтобы просто обращать внимание, люди и компании отвечают вам взаимностью. Когда вы пишете технический пост в блоге, вы получаете мгновенную обратную связь. Ваши технические статьи также помогают распространять информацию, открывая двери еще более интригующим возможностям. Также можно сделать прибыльную карьеру технического писателя, если вам это нравится, и практически все, что я пишу в своем в эти дни, — это концепции, которые я пытаюсь лучше понять. Если я не могу объяснить это в письменной форме, значит, у меня нет должного понимания. блоге Каковы примеры технического письма? Ваша роль как технического писателя заключается в переводе сложной технической информации на доступный и удобный язык. Техническое письмо включает в себя различные формы, включая создание пошаговых руководств и подробных руководств. Основная цель — облегчить понимание любых технических аспектов продукта или услуги как среди внутренних членов команды, так и среди конечных пользователей. Имея это в виду, следующие примеры технического письма должны дать вам четкое понимание. Обзор SuperTokens — альтернатива с открытым исходным кодом Auth0, Firebase Auth и AWS Cognito. Это очень простой пример обзора супертокенов и того, почему «супертокены» являются хорошей аутентификацией пользователя. Как использовать Medusa для создания интернет-магазина Next.js Это очень хороший пример того, как можно создать учебное пособие одновременно с созданием приложения. В этом блоге я поделился пошаговым руководством по созданию магазина электронной коммерции от Medusa, который является альтернативой Shopify с открытым исходным кодом. Как развернуть LLM с помощью MindsDB и OpenAI В этом руководстве я рассказал, как вы можете развернуть LLM с помощью MindDB и OpenAI. Как перенести базу данных из Supabase в HarperDB Полное руководство о том, как перенести базу данных из Supabase в HarperDB. 5- Документация на продукт Документация по продукту включает инструкции по эффективному использованию и интеграции с другими инструментами разработчика. Написание документации по продукту требует хороших технических навыков письма и организационных знаний. Это всего лишь пара примеров, относящихся к техническому написанию, которые требуют высокого уровня навыков в исследованиях, визуализации и способности общаться с самой разнообразной аудиторией. Совет: «Спросите себя: «Привлекает ли заголовок интерес читателя?» Если да, то они, скорее всего, углубятся во вступление, а затем решат: «Стоит ли тратить свое время на всю эту статью?» Одна распространенная ошибка, которую я часто наблюдаю в технических постах, — это избыточное введение или, наоборот, слишком малое. Точно составленный абзац может эффективно подготовить почву для технического поста в блоге. Как начать работу техническим писателем Безусловно, самый распространенный вопрос, который я получаю по поводу «технического письма или ведения блога», касается того, с чего начать. В жизни кажется, что самое большое препятствие на пути к тому, чтобы что-то сделать и стать тем, кем вы хотите стать, — это начать. Самый худший враг – это «неуверенность в себе». pic.twitter.com/fw1691QRSY — Анкур💻🎧💪 (@TheAnkurTyagi) 10 августа 2023 г. Будь то начало нового режима тренировок, подготовка к марафону, открытие бизнеса, написание книги или, точнее, в данном случае, писательство, самое сложное всегда — начать. Легко (и заманчиво) потратить бесчисленные часы на обсуждение того, что вам следует делать. Гораздо проще «читать», «читать» и «учиться», чем начать «писать». Но секрет в том, что вам нужно делать только один шаг за раз. Создайте хотя бы один комплексный актив за свою карьеру в области разработки программного обеспечения. – Запустить блог – Запустить информационный бюллетень – Начать записывать видео на YT – Запустить подкаст – Начать создавать сети Создавайте, публикуйте и повторяйте Будущие возможности ждут вас в Интернете Копия @TheAnkurTyagi — Кап.ц (@Kaperskyguru) 17 февраля 2023 г. И оглянись вокруг; большинство разработчиков программного обеспечения не пишут код круглосуточно; большинство из нас каждый день тратят много времени на другие дела. Это включает: Демонстрация новой функциональности всей командой внутри компании или клиентов. Документирование новой или старой функции вашего продукта. Обновление заявки, связанной с JIRA. Создание невыполненной работы для поддержки этой новой функции. Конечно, всегда есть время для перерыва в туалет/обеда и просмотра 😉 Твиттера так что не раздумывай, просто начни «Писать – это все равно, что учиться играть в баскетбол». — Дэвид Перелл Чтобы стать успешным писателем и находить возможности, вам необходимо обладать 3 навыками. Кодирование Письмо Английский Да, прежде чем вы начнете писать, вы должны сначала понять английский язык, включая его времена, написание и базовую грамматику. Ваши читатели не захотят читать статью, полную грамматических ошибок и неправильного выбора слов. В технологической индустрии английский стал де-факто языком общения между разработчиками программного обеспечения, инженерами и другими техническими специалистами по всему миру. Это язык, используемый для документации, языков программирования и инструментов, используемых для разработки. Научитесь выражать идеи просто и ясно Знание того, как реализовать техническую функцию, не обязательно означает, что вы можете объяснить этот процесс другим. Чтобы стать хорошим учителем, необходимы эмпатия и умение доносить информацию в форме, подходящей для вашей целевой аудитории. Вы чего-то не понимаете, если не можете объяснить это шестилетнему ребенку. Эйнштейн, Альберт Не существует безупречной стратегии, как стать исключительным писателем. Тогда вы можете задаться вопросом, почему я обсуждаю эту тему. Это потому, что очень важно решить эту проблему с самого начала. «Не ищите стратегию; ищите свой уникальный голос в письменной форме и создайте свой стиль». Единственный писательский прием, который вы должны знать. Меньше технологий — больше, я работаю с React 90% времени. Если вы пишите впервые, дайте себе больше времени, чтобы разобраться. Позвольте себе писать плохо. Перестаньте готовиться и начните действовать. Как стать выдающимся писателем в эпоху искусственного интеллекта: Прежде чем писать следующую публикацию в блоге, попросите ChatGPT написать ее по этой теме и показать вам, какие общие вещи уже доступны в Интернете, чтобы вы могли не говорить этого и писать то, что важно и уникально для аудитории. — Анкур💻🎧💪 (@TheAnkurTyagi) 16 февраля 2023 г. Чтобы понять свою аудиторию, задайте эти вопросы, прежде чем начать писать. Кто ваши читатели? Что они ищут в Google или с какой проблемой сталкиваются? Какие блоги они читают сейчас? Как они будут читать? Как придумать идеи для постов в блоге Напишите статью, которая не позволила бы вам часами гуглить и чесать затылок. Всякий раз, когда вы узнаете что-то новое, напишите о том, как вы это узнали и что вы узнали. Напишите рассказ о своей области, интересах или профессии. Выберите публикацию вашего любимого блоггера, которая вам понравилась, и изучите ту же тему с новой точки зрения или рассмотрите другую тему с аналогичной точки зрения. Напишите сообщение в блоге, которое вы хотели бы найти, когда что-то искали в Google. — Анкур💻🎧💪 (@TheAnkurTyagi) 20 марта 2023 г. Примечание. Если вы сделали что-то интересное в своей карьере разработчика программного обеспечения, но держите это при себе, вы упускаете большой генератор возможностей. Когда дело доходит до эффективного продвижения ваших идей, в Интернете лучше всего ориентироваться в письменном виде. Это прекрасное место для написания технических постов и руководств. Напишите для профессионала, у которого еще не было времени изучить эту вещь, и свяжите ее с вещами, которые они уже знают. Например, объяснение современной техники JS тому, кто знает jQuery. – Рэйчел Эндрю (@rachelandrew) 20 февраля 2019 г. Заключение Написание текстов — легкая задача для большинства опытных разработчиков. Если вы думаете, что можете многому научиться в сфере технологий, прочитав сообщение в блоге; попробуйте написать одно на этой неделе. — Анкур💻🎧💪 (@TheAnkurTyagi) 2 октября 2023 г. Причина, по которой каждый разработчик должен написать сообщение в блоге о том, что он изучает в области разработки программного обеспечения, заключается в том, что письмо заставляет его обнаружить, что, возможно, он не понимает что-то так хорошо, как он думал. Преподавание и написание о чем-либо — лучший способ узнать об этом, и начать новый образ жизни для вас — легко висящий плод, потому что у вас уже есть непосредственный опыт, поэтому все, что вам нужно сделать, это появиться и написать 12 сообщений в блоге. в этом году, оцените результаты и спланируйте свой следующий шаг! «Читайте, чтобы собрать точки, пишите, чтобы соединить их», — Дэвид Перелл. Суть в том, что оттачивание своих навыков письма и приложение дополнительных усилий в написании могут действительно улучшить ваши способности как разработчика. Эти советы могут оказаться полезными для сотрудничества с другими разработчиками, поддержания вашей работы, создания контента при необходимости или даже составления проектных предложений, а также для выполнения других задач. Ресурсы по техническому написанию (хорошо написанная запись в блоге Криса из CSS Tricks) Советы по техническому написанию (репозиторий GitHub, автор: ) Ресурсы для технического письма Синтия Питер Руководство Google по техническому написанию Основы технического письма Напишите документы Также опубликовано . здесь