Помимо того, что вы являетесь хорошим разработчиком, ваше мастерство в кодировании хорошо выставлено в вашей способности связывать и делать легкие технологии и рамки, с которыми вы сталкиваетесь на своем пути как программист, в технических статьях. Мало того, но вы также можете учить новичков и улучшать экспертов, и, что наиболее важно, сами, трудности в языке и то, как вы смогли преодолеть их, используя определенные технологии и структуры. В этой статье я беру вас на 10-летнюю лестницу о том, как вы можете стать успешным техническим писателем.
Заголовки, которые кричат: «Читайте дальше!»
Независимо от того, насколько интересным или образовательным может быть содержание вашей статьи, если у вас плохой заголовок, ни одному читателю не будет предложено посмотреть, что внутри. Заголовок можно сравнить с оберткой рождественского подарка, красота обертки создаст впечатление красивого контента в уме приемника, даже перед проверкой, но уродливая обертка с другой стороны создаст уродливое впечатление от контента. Как технический писатель, вы должны быть разборчивы в своем выборе заголовка для вашей статьи. Заголовки, которые убедит и прибудет читателей прочитать контент. Заголовок должен быть введен в статью после завершения контента, потому что контент будет определять и должен соответствовать указанному заголовку. Ваш заголовок не должен создавать аппетитное впечатление от пиццы и при потреблении дает вкус, то есть вы не должны давать своей статье заголовок, который не предоставляет то, что она указывает в содержании статьи, это только заставит читателей фильтровать отфильтровать любая недавно созданная статья. Ваши заголовки должны говорить: «Продолжить чтение!»
Учиться и придерживаться конкретной технологии или структуры
Будь то бэкэнд, бэкэнд, искусственный интеллект, машинное обучение или любой разработчик программного обеспечения, кредит привыкания к конкретной технологии или структуре не может быть занижен, особенно в техническом письме. Аудитория, для которой вы пишете, следует воспринимать в качестве новичков или промежуточных продуктов для любого программного обеспечения, на котором вы пишете, и объяснение языка или технологии, с которыми вы не соответствуете, заставит вас выглядеть как запутанный сотрудник. Это более опасно со стороны новичка, потому что они, как правило, практикуют любой новый навык, который они изучают, и ваше несоответствие в объяснении окажется плохим в том, что они делают, даже до такой степени, что он отказывается от языка , или, что еще хуже, программирование. Более того, написание о технологии, с которой вы очень хорошо знакомы и привыкли, после испытаний заставит читателей возвращаться к статье, выразить глубокую благодарность и даже включить колокол уведомлений, ожидая вашей следующей статьи, потому что они знали, что Они получили из предыдущего и с нетерпением ждут того, что они получат в последнем выпуске. Итак, вы понимаете, почему для вас важно писать, основываясь на вашем опыте знакомого языка или технологий. Так же, как это может быть очень полезно, когда они хорошо сделаны, это также может быть опасно, если вы не подходят для этого.
Знайте уловки, ярлыки и простой метод получения проблем Решен
Аудитория рассчитывает получить лучший и более простой способ сделать то, с чем они боролись в течение долгого времени. Представление ярлыков и трюков также может заставить читателей понять, что потраченное время, потраченное впустую на написание длинных строк кода, может быть значительно сокращено при написании короткой линии кода и все еще достигая того же результата. Ярлыки, трюки, лучшие способы, если не все, принять большую часть своей статьи, потому что это то, что читатели хотят видеть.
Держите это ясным, простым и кратким
Вы не ожидаете, что вы потратите много времени на переваривание длинного и напряженного объяснения, когда это может быть выражено в простых терминах, сохраняя точки нетронутыми. Так же, как вам нелегко сделать это, представьте себе беспокойство, которое вы можете заставить читателей пройти, если вы виноваты в этом. Написание длинных объяснений может легко унести читателей и заставит их пропустить следующую статью. Только у вас нет статьи по этой теме! Кроме того, обязательно организуйте свой контент в порядке повышения срочности. От введения к наименее важным, последовательно связывающемуся с наиболее важным и, наконец, заканчивая его выводом; Короткий резюме того, что ожидается от читателей, узнал.
Держите это простым, ясным и кратким, это значение.
Будьте однозначны в вашем языке
Представьте, что вы читаете книгу, и в то же время открывается словарь, чтобы найти странные слова и термины, это унизительно! Если есть простые слова, которые можно использовать, используйте их. Вы не пишете, чтобы показать свою эрудицию на английском языке, вместо этого ваше мастерство в коде – это то, что нужно. Есть много инструментов, которые могут быть полезны, разбивая длинные словарь и сохраняя его значение, например, грамматическое. Он имеет бесплатную версию, которая может быть установлена и используется. Это также исправляет грамматические ошибки. Более того, желательно придерживаться конкретного человека и напряженного, чтобы не допускать запутывания и самого себя, и читателя.
Четко определите использованную аббревиатуру, если возможно, избегайте этого
При написании технических статей очень важно минимизировать использование аббревиатуры. И всякий раз, когда он используется, его значение должно быть четко указано близко к нему, и в повторном использовании полное значение не должно быть далеко от него, то есть аббревиатура и полное значение не могут быть в начале страницы и использоваться повторно Один в нижней части страницы. Полное значение может быть легко забыто, если не указано должным образом, заставляя читателя прокручивать вверх и вниз, чтобы помнить. Чтобы быть на более безопасной стороне, лучше сделать полностью без него и использовать только полное значение.
Оставайся в ясном от плагиата!
Плагиат – это акт повторного использования чужой работы и не правильно ссылаться на владельца работы или вообще. Известно, что этот акт снял много писателей, как только был обнаружен писатель Анкет На это также можно оштрафовать, если это работа, защищенное авторским правом. Перефразирование, которое представляет собой подъем и копирование работы другого автора, то есть повторного и пересталки пойман с поличным. Как технический писатель, вы должны избегать плагиата и перефразирования, когда вы цитируете чужую работу, правильно цитируйте владельца и откуда это взято. Существуют инструменты, которые следует использовать, чтобы избежать этих ловушек, в которые большинство авторов, как правило, попадают, например, Pharearism Checker, приложение, которое проверяет на скопированные работы. Хорошо, чтобы использовать его.
Перейдите к другой технологии или структуре, переверните, станьте лучше
После того, как вы стали основанием на языке или технологии, вы должны перейти к новой, изучить его основы, уловки, ярлыки, потому что это то, что читатели ожидают от вас, и простые методы. Они всегда смотрят на новый трюк каждый раз, когда читают вашу статью, и рано или поздно ваша статья станет задушкой, если она только предлагает конкретную технологию. Это не будет круто. Более того, это побуждает читателей изучить другие языки и рамки. Хотя это кропотливо, проходя через другую технологию и изучает свои основы, чтобы сделать вещи простыми для читателей, но, поверьте мне, окупается. Вы продвигаете свою игру в технологии, и читатели получают больше знаний от вас. Так что двигайтесь и шагайте по своей игре.
Быть открытым для критики, мазки и исправлений
Независимо от того, насколько хорошей может быть ваша статья, вы обязательно будете подвергаться критике со стороны читателей, тех, кто может быть лучше в ней, чем вы или другие, которые просто имеют привычку к критике. В критических замечаниях вы узнаете, что вы узнаете лучший способ сделать это, некоторые из которых вы не знаете или, возможно, пропустили, раскрываются, и вы становитесь лучше, принимая в исправления. Никогда не спускайтесь из -за критики и не остановите то, что вы делаете, вместо этого учитесь на этом, пристегитесь к ней и станьте лучше.
Оживить свои статьи
Чтение целых длинных строк текста может вскоре стать утомительным для читателей и заставить их прокручивать вниз, а не просматривать или хуже оставить свою статью для другой. Оживите свои статьи картинками и GIF -файлами, которые относятся к предмету. Картинки и гифки служат успокаивающей панацеей для читателей и коротким перерывом, чтобы успокоить их, читая для лучшего понимания. Не делайте свою статью для читателей, оживите ее. Более того, не испытывайте искушения набрать всю страницу с изображениями и GIF -файлами, они делают статью по -детски. Оживите свои статьи, будьте умеренными.
В этой статье вы узнали, как передавать знания технологий другим путем написания великих технических статей в десяти простых шагах. Хорошее продолжение этих шагов в кратчайшие сроки поможет вам подняться на вершину технического письма и, вероятно, в зависимости от вашей ловкости, принесите свою работу. Оставайтесь с нами за больше статей от меня. Продолжить в моей учетной записи в Твиттере Доктор Прайм Для получения дополнительных обновлений. Не забудьте любить, передавать свои мысли и поделиться с друзьями, которые должны это увидеть. Спасибо за чтение!!!
Оригинал: “https://dev.to/drprime01/10-useful-tips-to-successful-technical-writing-4d65”