Вам знакомо это чувство, когда в глубине души вы понимаете, что хотите поговорить о технической теме, но не знаете, как правильно изложить ее в статье?
Найти правильный ракурс для того чтобы донести нужную мысль, иногда бывает непросто. Особенно когда речь идет о технических темах, таких как наука о данных или аналитика данных. Если дополнить к этому непростую задачу по созданию логической структуры статьи и ее иллюстрации, то рождение хорошей публикации может быть реальным испытанием.
Прежде всего, почему вы, как практик, работающий с данными, должны быть заинтересованы в написании технической статьи? Во-первых, это возможность четко формулировать свои мысли. Как аналитику данных, написание статей в интернете помогает мне задокументировать лучшие практики, которые я применяю в своей повседневной жизни. Иногда при объяснении той или иной концепции коллеге я ссылаюсь на одну из своих статей: проделав однажды работу по записи определенных этапов своего опыта, впоследствии легче ссылаться на них. Есть и другие причины для написания технических статей, которые могут не иметь прямого отношения к вашей работе с данными. Когда вы изучаете тему более глубоко, то узнаете что-то новое. Написание статей — это также упражнение для повышения творческого потенциала и, возможно, уверенности в себе.
Каждый автор найдет свои собственные причины для того, чтобы заниматься техническими статьями. После написания статей, связанных с данными — большинство из них опубликовано в издании Towards Data Science — я хочу поделиться с вами своими личными советами по формулированию статьи о данных, чтобы вы могли воспользоваться преимуществами технического письма.
Как и для строительства дома, у вас должен быть:
крепкая основа (фундамент)
хорошо продуманная конструкция
красивое внутреннее оформление
#1 Фундамент
Независимо от темы, которую вы затрагиваете, хорошее вступление начинается с ключевой фразы. Всего по нескольким словам читатель должен понять, о чем эта статья. Он должен найти причину, почему ему следует читать вашу статью дальше.
Лучший способ сделать это — найти проблемный момент, который затрагивает ваша статья. Исходя из того, как именно раскрывается тема, вы предлагаете читателю решение его трудностей. Для вас как для писателя не всегда очевидно связать тему статьи с проблемным аспектом, но я считаю очень полезным написать броское вступление - или даже несколько черновиков, прежде чем вы выберете подходящий ракурс.
Вот несколько примеров проблемных ситуаций:
Вы хотите разработать техническую концепцию и подробно объяснить ее читателю?
→ Проблема может выражаться в следующем: "Если вы запутались в этой концепции или никогда о ней не слышали, прочтите мою статью ниже, и вы получите ясное представление о ней"
Хотите ли вы пройти через методологию, чтобы что-то сделать?
→ Проблема может быть такой: "Если вы не знаете, как это сделать, прочитайте мою статью ниже, и вы сможете сделать это самостоятельно"
Вы хотите поделиться передовым опытом по какому-либо вопросу?
→ Проблема может быть сформулирована таким образом: "Знаете ли вы, что можете сделать это лучше? Возможно, вы делаете это неправильно, поэтому прочитайте мою статью ниже, чтобы улучшить свою практику"
Самое главное — возьмите читателя за руку с самого начала. В частности, когда вы затрагиваете техническую тему, очень важно определить термины, используемые в статье. Если необходимо добавить какие-либо нюансы между терминами, то введение статьи — самое подходящее место для этого.
#2 Конструкция
Я обычно пишу свое содержание в трех частях — это определенно наследие моей учебы. Но ничто не мешает вам создать совершенно инновационную структуру. Как по мне, структура из трех частей позволяет мне детализировать свои идеи настолько, что я могу развивать одну и ту же мысль в нескольких абзацах, при этом хочется, чтобы статья оставалась относительно компактной и не слишком длинной для чтения. Поэтому трех подробных частей обычно бывает достаточно.
Что касается наилучшего способа структурирования статьи, то за время своей работы техническим автором я выявила некоторые закономерности. В зависимости от того, какую мысль вы хотите донести через свою статью и какие отношения вы хотите установить со своим читателем, один вариант структуры статьи может быть более уместным, чем другие.
Вариант А: Вы хотите привести доводы в пользу того или иного утверждения
В этом типе статей вы должны сосредоточиться на аргументации своего утверждения. Для этого во вступлении следует изложить суть дела. Это позволит читателю понять контекст, в рамках которого происходит аргументация.
В основной части статьи каждый аргумент должен быть подкреплен примером. Здесь вы можете либо взять один пример и упоминать его в каждом фрагменте статьи, либо подкрепить каждый абзац конкретным примером. Примеры подкрепят ваши высказывания и позволят читателю понять, что вы имеете в виду под каждым аргументом.
Наконец, заключение должно включать в себя краткий обзор всех ваших аргументов, а также возможные контраргументы и ограничения только что приведенного вами аргумента.
Вариант B: Вы хотите объяснить читателю некую концепцию
В таком типе статьи потребуются все педагогические навыки, поскольку ее цель — сделать сложную концепцию простой для понимания. Кроме того, вы хотите, чтобы ваш читатель стал хорошо разбираться в представленной концепции. Для этого я использую прием: составляю содержание в виде вопросов и ответов. Это усиливает ощущение того, что вы находитесь в классе с увлеченным преподавателем, который разбирает каждый вопрос, который может возникнуть у студентов.
Поэтому хорошее предисловие включает в себя определения терминов, которые будут использоваться в вашей статье. Даже если вы будете углубляться в детали позже в тексте, начало с определений дает читателю уверенность в том, что вы подробно объясните каждый элемент.
Важнейшим аспектом статей такого типа является использование графических элементов для объяснения понятий. Читателям с развитой зрительной памятью это поможет раскрыть понимание некоторых, возможно, сложных концепций.
Вариант C: Вы хотите обучить своего читателя, как что-то сделать
Это типичная обучающая статья. В подобной структуре особенно важно использовать пример на протяжении всей статьи. Это можно сделать либо во введении, либо в первой части.
После представления примера вы возьмете читателя за руку и проведете его через все этапы решения проблемы. Поэтому для удобства я настаиваю на нумерации шагов и абзацев, чтобы было легче следовать за обучающим руководством.
Кроме того, ничто не сравнится со сниппетами и скриншотами для того чтобы сделать каждое действие наглядным. Открытость в описании способа решения проблемы, указанной во введении, вызывает доверие у читателя: если он сможет повторить пройденные вами шаги, велика вероятность того, что ваш учебник действительно полезен.
#3 Оформление
Теперь, когда основные части вашего дома (или, лучше сказать, вашей статьи) построены, пришло время добавить к ним декоративные элементы.
Здесь я хочу поговорить о картинках и иллюстрациях к вашей статье. Часто говорят, что "одна картинка стоит тысячи слов"... Признаюсь, я считаю это высказывание очень актуальным. Чтобы произвести впечатление на читателя, нет ничего лучше подходящей иллюстрации. Есть два пути: либо вы создаете собственную иллюстрацию, либо берете ее из интернета, или комбинируете оба способа. Если вы не создаете собственную иллюстрацию, убедитесь, что у вас есть права на использование чужой работы.
И последнее, но не менее важное: общий вид вашей статьи. Я имею в виду, что перед публикацией статьи вы должны проверить следующие моменты:
эстетика: гармония между картинками и текстом, между самими абзацами текста и т.д.
правильность: отсутствие орфографических ошибок, корректные данные, правильные фрагменты кода и т.д.
полнота: убедитесь, что вы затронули все темы, упомянутые во введении.
... и вы готовы нажать кнопку "Опубликовать"!
Заключение
С прочным фундаментом (поиск проблемного момента, для решения которого предназначена ваша статья), хорошо продуманной структурой (выбранной на основе цели вашей статьи) и некоторыми красивыми элементами внутреннего оформления (иллюстрации и визуальная согласованность вашей статьи), ваша техническая статья теперь готова к публикации для читателей.
Приглашаем всех желающих на открытое занятие «Основы статистики». На вебинаре узнаем о двух основополагающих понятиях в статистике — выборке и генеральной совокупности. Дополнительно узнаем, что такое типы переменных и какие они бывают.