Интернет является одним из величайших источников обучения. Как и все, программисты полагаются на Интернет, чтобы учиться и совершенствовать навыки. Написание статей по программированию(PA) отличается от написания других типов статей. Это связано с тем, что статьи по программированию должны объяснять ментальные концепции, такие как логика или математика, лежащие в основе проблемы, за которыми следует объяснение кода. Даже при хорошем качестве письма понять эти ментальные концепции немного сложно.

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

Советы по эффективному PA:

1) Объясните простые вещи. Не размещайте просто некоторые команды или блоки кода и заканчивайте их абзацем с объяснением. При необходимости дайте адекватное объяснение того, что делает каждая команда или блок кода. Под объяснением я не имею в виду объяснить все об этом. Просто четкой и краткой строчки об этом было бы достаточно. Объяснение может быть в таких местах, как ниже блока кода или команды или внутри кода с комментариями.
Объясняя, что делает каждая команда или блок кода, читатель может активно понимать каждую часть программы, а не просто запоминать весь код.

2) Не размещайте код на одном конце, а пояснения на другом конце:
 Допустим, читатель читает статью, в которой весь код находится вверху, а пояснения внизу. . Читатель должен спуститься вниз, чтобы прочитать часть объяснения, и перейти наверх, чтобы понять код. Вы снова спускаетесь вниз, чтобы читать, и поднимаетесь вверх, чтобы понять код. Как вы можете заметить, читатель должен пройти всю страницу много раз, чтобы понять статью. Статьи, написанные таким образом, читать утомительно.
Статьи должны быть написаны таким образом, чтобы пользователь плавно читал сверху вниз, а не прыгал по странице. Для удобства чтения поместите блок кода с пояснением. Продолжайте до тех пор, пока не будут объяснены все отдельные блоки кода. Внизу поместите весь свой код в одном месте.

3) По возможности используйте изображения, таблицы, метафоры и мультимедиа:

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

Изображения легки для мозга. На самом деле мозг обрабатывает изображения в 60 000 раз быстрее, чем текст. Как и на изображении выше, попробуйте объяснить концепции с помощью изображений. Распространенный вопрос: как можно использовать изображения в PA? Попробуйте заменить блок текста, объясняющий логику, блок-схемой. Этот простой прием облегчает усвоение содержания и поддерживает интерес читателя.

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

Я узнал об этом из книги под названием Learning How to Learn.

4) Делайте вещи интересными:

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

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

Это все на данный момент. Если есть что-то, что я пропустил, пожалуйста, дайте мне знать.

Спасибо за чтение.